@lobehub/chat 1.79.10 → 1.80.0

package/src/database/migrations/meta/_journal.json

@@ -147,6 +147,13 @@
       "when": 1744458287757,
       "tag": "0020_add_oidc",
       "breakpoints": true
+    },
+    {
+      "idx": 21,
+      "version": "7",
+      "when": 1744602998656,
+      "tag": "0021_add_agent_opening_settings",
+      "breakpoints": true
     }
   ],
   "version": "6"

package/src/database/repositories/dataImporter/deprecated/__tests__/fixtures/messages.json

@@ -926,6 +926,8 @@
             "ttsService": "openai",
             "voice": { "openai": "alloy" }
           },
+          "openingMessage": "I'm an AI assistant, how can I help you today?",
+          "openingQuestions": ["Question 1", "Question 2"],
           "chatConfig": {
             "autoCreateTopicThreshold": 2,
             "displayMode": "chat",

package/src/database/repositories/dataImporter/deprecated/__tests__/index.test.ts

@@ -94,6 +94,7 @@ describe('DataImporter', () => {
               params: {},
               systemRole: 'abc',
               tts: {} as any,
+              openingQuestions: [],
             },
             meta: {
               title: 'Session 1',
@@ -110,6 +111,7 @@ describe('DataImporter', () => {
               params: {},
               systemRole: 'abc',
               tts: {} as any,
+              openingQuestions: [],
             },
             meta: {
               title: 'Session 2',
@@ -156,6 +158,7 @@ describe('DataImporter', () => {
               params: {},
               systemRole: 'abc',
               tts: {} as any,
+              openingQuestions: [],
             },
             meta: {
               title: 'Session 1',
@@ -172,6 +175,7 @@ describe('DataImporter', () => {
               params: {},
               systemRole: 'abc',
               tts: {} as any,
+              openingQuestions: [],
             },
             meta: {
               title: 'Session 2',
@@ -207,6 +211,7 @@ describe('DataImporter', () => {
               params: {},
               systemRole: 'abc',
               tts: {} as any,
+              openingQuestions: [],
             },
             meta: {
               title: 'Session 1',
@@ -224,6 +229,7 @@ describe('DataImporter', () => {
               params: {},
               systemRole: 'abc',
               tts: {} as any,
+              openingQuestions: [],
             },
             meta: {
               title: 'Session 2',
@@ -241,6 +247,7 @@ describe('DataImporter', () => {
               params: {},
               systemRole: 'abc',
               tts: {} as any,
+              openingQuestions: [],
             },
             meta: {
               title: 'Session 3',
@@ -287,6 +294,7 @@ describe('DataImporter', () => {
               params: {},
               systemRole: 'Test Agent 1',
               tts: {} as any,
+              openingQuestions: [],
             },
             meta: {
               title: 'Session 1',
@@ -303,6 +311,7 @@ describe('DataImporter', () => {
               params: {},
               systemRole: 'Test Agent 2',
               tts: {} as any,
+              openingQuestions: [],
             },
             meta: {
               title: 'Session 2',
@@ -367,6 +376,7 @@ describe('DataImporter', () => {
               params: {},
               systemRole: 'Test Agent 1',
               tts: {} as any,
+              openingQuestions: [],
             },
             meta: {
               title: 'Session 1',
@@ -390,6 +400,7 @@ describe('DataImporter', () => {
               params: {},
               systemRole: 'Test Agent 1',
               tts: {} as any,
+              openingQuestions: [],
             },
             meta: {
               title: 'Session 1',
@@ -439,6 +450,7 @@ describe('DataImporter', () => {
               params: {},
               systemRole: 'abc',
               tts: {} as any,
+              openingQuestions: [],
             },
             meta: {
               title: 'Session 1',
@@ -455,6 +467,8 @@ describe('DataImporter', () => {
               params: {},
               systemRole: 'abc',
               tts: {} as any,
+              openingQuestions: [],
+              openingMessage: `Hello, I'm Agent 2, learn more from [xxx](https://xxx.com)`,
             },
             meta: {
               title: 'Session 2',
@@ -507,6 +521,7 @@ describe('DataImporter', () => {
               params: {},
               systemRole: 'abc',
               tts: {} as any,
+              openingQuestions: [],
             },
             meta: {
               title: 'Session 1',
@@ -582,6 +597,7 @@ describe('DataImporter', () => {
               params: {},
               systemRole: 'abc',
               tts: {} as any,
+              openingQuestions: [],
             },
             meta: {
               title: 'Session 1',
@@ -661,6 +677,7 @@ describe('DataImporter', () => {
               params: {},
               systemRole: 'abc',
               tts: {} as any,
+              openingQuestions: [],
             },
             meta: {
               title: 'Session 1',
@@ -872,6 +889,8 @@ describe('DataImporter', () => {
                   enableAutoCreateTopic: true,
                   historyCount: 1,
                 },
+                openingQuestions: ['Question 1', 'Question 2'],
+                openingMessage: `Hello, I'm Agent 1, learn more from [xxx](https://xxx.com)`,
               },
               group: 'XlUbvOvL',
               meta: {

package/src/database/schemas/agent.ts

@@ -54,6 +54,9 @@ export const agents = pgTable(
     systemRole: text('system_role'),
     tts: jsonb('tts').$type<LobeAgentTTSConfig>(),
 
+    openingMessage: text('opening_message'),
+    openingQuestions: text('opening_questions').array().default([]),
+
     ...timestamps,
   },
   (t) => ({

package/src/features/AgentSetting/AgentOpening/OpeningMessage.tsx

@@ -0,0 +1,80 @@
+'use client';
+
+import { EditableMessage } from '@lobehub/ui';
+import { Button } from 'antd';
+import { createStyles } from 'antd-style';
+import { PencilLine } from 'lucide-react';
+import { memo, useCallback, useState } from 'react';
+import { useTranslation } from 'react-i18next';
+import { Flexbox } from 'react-layout-kit';
+
+import { useStore } from '../store';
+import { selectors } from '../store/selectors';
+
+export const useStyles = createStyles(({ css, token }) => ({
+  markdown: css`
+    border: unset;
+  `,
+  wrapper: css`
+    width: 100%;
+    padding: 8px;
+    border: 1px solid ${token.colorBorder};
+    border-radius: ${token.borderRadiusLG - 1}px;
+
+    background: ${token.colorBgContainer};
+  `,
+}));
+
+const OpeningMessage = memo(() => {
+  const { t } = useTranslation('setting');
+  const { styles } = useStyles();
+
+  const openingMessage = useStore(selectors.openingMessage);
+  const updateConfig = useStore((s) => s.setAgentConfig);
+  const setOpeningMessage = useCallback(
+    (message: string) => {
+      updateConfig({ openingMessage: message });
+    },
+    [updateConfig],
+  );
+
+  const [editing, setEditing] = useState(false);
+
+  const handleEdit = useCallback(() => {
+    setEditing(true);
+  }, []);
+
+  const editIconButton = !editing && openingMessage && (
+    <Button onClick={handleEdit} size={'small'}>
+      <PencilLine size={16} />
+    </Button>
+  );
+
+  return (
+    <div className={styles.wrapper}>
+      <Flexbox direction={'horizontal'}>
+        <EditableMessage
+          classNames={{
+            markdown: styles.markdown,
+          }}
+          editButtonSize={'small'}
+          editing={editing}
+          height={'auto'}
+          inputType={'pure'}
+          onChange={setOpeningMessage}
+          onEditingChange={setEditing}
+          placeholder={t('settingOpening.openingMessage.placeholder')}
+          showEditWhenEmpty
+          text={{
+            cancel: t('cancel', { ns: 'common' }),
+            confirm: t('ok', { ns: 'common' }),
+          }}
+          value={openingMessage ?? ''}
+        />
+        {editIconButton}
+      </Flexbox>
+    </div>
+  );
+});
+
+export default OpeningMessage;

package/src/features/AgentSetting/AgentOpening/OpeningQuestions.tsx

@@ -0,0 +1,144 @@
+'use client';
+
+import { DeleteOutlined, PlusOutlined } from '@ant-design/icons';
+import { SortableList } from '@lobehub/ui';
+import { Button, Empty, Input } from 'antd';
+import { createStyles } from 'antd-style';
+import { memo, useCallback, useMemo, useState } from 'react';
+import { useTranslation } from 'react-i18next';
+import { Flexbox } from 'react-layout-kit';
+
+import { useStore } from '../store';
+import { selectors } from '../store/selectors';
+
+const useStyles = createStyles(({ css, token }) => ({
+  empty: css`
+    margin-block: 24px;
+    margin-inline: 0;
+  `,
+  questionItemContainer: css`
+    margin-block-end: 8px;
+    padding-block: 2px;
+    padding-inline: 10px 0;
+    background: ${token.colorBgContainer};
+  `,
+  questionItemContent: css`
+    flex: 1;
+  `,
+  questionsList: css`
+    width: 100%;
+    margin-block-start: 16px;
+  `,
+  repeatError: css`
+    margin: 0;
+    color: ${token.colorErrorText};
+  `,
+}));
+
+interface QuestionItem {
+  content: string;
+  id: number;
+}
+
+const OpeningQuestions = memo(() => {
+  const { t } = useTranslation('setting');
+  const { styles } = useStyles();
+  const [questionInput, setQuestionInput] = useState('');
+
+  const openingQuestions = useStore(selectors.openingQuestions);
+  const updateConfig = useStore((s) => s.setAgentConfig);
+  const setQuestions = useCallback(
+    (questions: string[]) => {
+      updateConfig({ openingQuestions: questions });
+    },
+    [updateConfig],
+  );
+
+  const addQuestion = useCallback(() => {
+    if (!questionInput.trim()) return;
+
+    setQuestions([...openingQuestions, questionInput.trim()]);
+    setQuestionInput('');
+  }, [openingQuestions, questionInput, setQuestions]);
+
+  const removeQuestion = useCallback(
+    (content: string) => {
+      const newQuestions = [...openingQuestions];
+      const index = newQuestions.indexOf(content);
+      newQuestions.splice(index, 1);
+      setQuestions(newQuestions);
+    },
+    [openingQuestions, setQuestions],
+  );
+
+  // 处理拖拽排序后的逻辑
+  const handleSortEnd = useCallback(
+    (items: QuestionItem[]) => {
+      setQuestions(items.map((item) => item.content));
+    },
+    [setQuestions],
+  );
+
+  const items: QuestionItem[] = useMemo(() => {
+    return openingQuestions.map((item, index) => ({
+      content: item,
+      id: index,
+    }));
+  }, [openingQuestions]);
+
+  const isRepeat = openingQuestions.includes(questionInput.trim());
+
+  return (
+    <Flexbox gap={8}>
+      <Flexbox gap={4}>
+        <Input
+          addonAfter={
+            <Button
+              // don't allow repeat
+              disabled={openingQuestions.includes(questionInput.trim())}
+              icon={<PlusOutlined />}
+              onClick={addQuestion}
+              size="small"
+              type="text"
+            />
+          }
+          onChange={(e) => setQuestionInput(e.target.value)}
+          onPressEnter={addQuestion}
+          placeholder={t('settingOpening.openingQuestions.placeholder')}
+          value={questionInput}
+        />
+
+        {isRepeat && (
+          <p className={styles.repeatError}>{t('settingOpening.openingQuestions.repeat')}</p>
+        )}
+      </Flexbox>
+
+      <div className={styles.questionsList}>
+        {openingQuestions.length > 0 ? (
+          <SortableList
+            items={items}
+            onChange={handleSortEnd}
+            renderItem={(item) => (
+              <SortableList.Item className={styles.questionItemContainer} id={item.id}>
+                <SortableList.DragHandle />
+                <div className={styles.questionItemContent}>{item.content}</div>
+                <Button
+                  icon={<DeleteOutlined />}
+                  onClick={() => removeQuestion(item.content)}
+                  type="text"
+                />
+              </SortableList.Item>
+            )}
+          />
+        ) : (
+          <Empty
+            className={styles.empty}
+            description={t('settingOpening.openingQuestions.empty')}
+          />
+        )}
+      </div>
+    </Flexbox>
+  );
+});
+
+export default OpeningQuestions;

package/src/features/AgentSetting/AgentOpening/index.tsx

@@ -0,0 +1,52 @@
+'use client';
+
+import { Form } from '@lobehub/ui';
+import { memo } from 'react';
+import { useTranslation } from 'react-i18next';
+
+import { FORM_STYLE } from '@/const/layoutTokens';
+
+import OpeningMessage from './OpeningMessage';
+import OpeningQuestions from './OpeningQuestions';
+
+const wrapperCol = {
+  style: {
+    maxWidth: '100%',
+    width: '100%',
+  },
+};
+
+const AgentOpening = memo(() => {
+  const { t } = useTranslation('setting');
+
+  return (
+    <Form
+      items={[
+        {
+          children: [
+            {
+              children: <OpeningMessage />,
+              desc: t('settingOpening.openingMessage.desc'),
+              label: t('settingOpening.openingMessage.title'),
+              layout: 'vertical',
+              wrapperCol,
+            },
+            {
+              children: <OpeningQuestions />,
+              desc: t('settingOpening.openingQuestions.desc'),
+              label: t('settingOpening.openingQuestions.title'),
+              layout: 'vertical',
+              wrapperCol,
+            },
+          ],
+          title: t('settingOpening.title'),
+        },
+      ]}
+      itemsType={'group'}
+      variant={'pure'}
+      {...FORM_STYLE}
+    />
+  );
+});
+
+export default AgentOpening;

package/src/features/AgentSetting/store/selectors.ts

@@ -6,6 +6,9 @@ import { Store } from './action';
 const chatConfig = (s: Store): LobeAgentChatConfig =>
   s.config.chatConfig || DEFAULT_AGENT_CHAT_CONFIG;
 
+export const DEFAULT_OPENING_QUESTIONS: string[] = [];
 export const selectors = {
   chatConfig,
+  openingMessage: (s: Store) => s.config.openingMessage,
+  openingQuestions: (s: Store) => s.config.openingQuestions || DEFAULT_OPENING_QUESTIONS,
 };

package/src/locales/default/setting.ts

@@ -6,6 +6,7 @@ export default {
     chat: '聊天偏好',
     meta: '助手信息',
     modal: '模型设置',
+    opening: '开场设置',
     plugin: '插件设置',
     prompt: '角色设定',
     tts: '语音服务',
@@ -255,6 +256,21 @@ export default {
       title: '思维开放度',
     },
   },
+  settingOpening: {
+    openingMessage: {
+      desc: '打开会话时的开场消息，用来介绍助手的功能',
+      placeholder: '你好，我是自定义助手。你可以立即与我开始对话，也可以前往助手设置完善我的信息。',
+      title: '开场消息',
+    },
+    openingQuestions: {
+      desc: '会话开始时展示的引导性问题',
+      empty: '暂无问题',
+      placeholder: '请输入问题',
+      repeat: '问题已存在',
+      title: '开场问题',
+    },
+    title: '开场设置',
+  },
   settingPlugin: {
     title: '插件列表',
   },

package/src/migrations/FromV5ToV6/types/v6.ts

@@ -29,6 +29,8 @@ export interface V6AgentConfig {
   chatConfig: ChatConfig;
   fewShots?: FewShots;
   model: string;
+  openingMessage?: string;
+  openingQuestions?: string[];
   params: LLMParams;
   plugins?: string[];
   provider?: string;

package/src/server/routers/lambda/session.ts

@@ -76,7 +76,14 @@ export const sessionRouter = router({
     .input(
       z.object({
         config: insertAgentSchema
-          .omit({ chatConfig: true, plugins: true, tags: true, tts: true })
+          .omit({
+            chatConfig: true,
+            openingMessage: true,
+            openingQuestions: true,
+            plugins: true,
+            tags: true,
+            tts: true,
+          })
           .passthrough()
           .partial(),
         session: insertSessionSchema.omit({ createdAt: true, updatedAt: true }).partial(),

package/src/services/import/client.test.ts

@@ -102,6 +102,7 @@ describe('ImporterService', () => {
               params: {},
               systemRole: 'abc',
               tts: {} as any,
+              openingQuestions: [],
             },
             meta: {
               title: 'Session 1',
@@ -118,6 +119,7 @@ describe('ImporterService', () => {
               params: {},
               systemRole: 'abc',
               tts: {} as any,
+              openingQuestions: [],
             },
             meta: {
               title: 'Session 2',
@@ -169,6 +171,7 @@ describe('ImporterService', () => {
               params: {},
               systemRole: 'abc',
               tts: {} as any,
+              openingQuestions: [],
             },
             meta: {
               title: 'Session 1',
@@ -185,6 +188,7 @@ describe('ImporterService', () => {
               params: {},
               systemRole: 'abc',
               tts: {} as any,
+              openingQuestions: [],
             },
             meta: {
               title: 'Session 2',
@@ -225,6 +229,7 @@ describe('ImporterService', () => {
               params: {},
               systemRole: 'abc',
               tts: {} as any,
+              openingQuestions: [],
             },
             meta: {
               title: 'Session 1',
@@ -242,6 +247,7 @@ describe('ImporterService', () => {
               params: {},
               systemRole: 'abc',
               tts: {} as any,
+              openingQuestions: [],
             },
             meta: {
               title: 'Session 2',
@@ -259,6 +265,7 @@ describe('ImporterService', () => {
               params: {},
               systemRole: 'abc',
               tts: {} as any,
+              openingQuestions: [],
             },
             meta: {
               title: 'Session 3',
@@ -310,6 +317,7 @@ describe('ImporterService', () => {
               params: {},
               systemRole: 'Test Agent 1',
               tts: {} as any,
+              openingQuestions: [],
             },
             meta: {
               title: 'Session 1',
@@ -326,6 +334,7 @@ describe('ImporterService', () => {
               params: {},
               systemRole: 'Test Agent 2',
               tts: {} as any,
+              openingQuestions: [],
             },
             meta: {
               title: 'Session 2',
@@ -390,6 +399,7 @@ describe('ImporterService', () => {
               params: {},
               systemRole: 'Test Agent 1',
               tts: {} as any,
+              openingQuestions: [],
             },
             meta: {
               title: 'Session 1',
@@ -413,6 +423,7 @@ describe('ImporterService', () => {
               params: {},
               systemRole: 'Test Agent 1',
               tts: {} as any,
+              openingQuestions: [],
             },
             meta: {
               title: 'Session 1',
@@ -462,6 +473,7 @@ describe('ImporterService', () => {
               params: {},
               systemRole: 'abc',
               tts: {} as any,
+              openingQuestions: [],
             },
             meta: {
               title: 'Session 1',
@@ -478,6 +490,7 @@ describe('ImporterService', () => {
               params: {},
               systemRole: 'abc',
               tts: {} as any,
+              openingQuestions: [],
             },
             meta: {
               title: 'Session 2',
@@ -544,6 +557,7 @@ describe('ImporterService', () => {
               params: {},
               systemRole: 'abc',
               tts: {} as any,
+              openingQuestions: [],
             },
             meta: {
               title: 'Session 1',
@@ -619,6 +633,7 @@ describe('ImporterService', () => {
               params: {},
               systemRole: 'abc',
               tts: {} as any,
+              openingQuestions: [],
             },
             meta: {
               title: 'Session 1',
@@ -711,6 +726,7 @@ describe('ImporterService', () => {
               params: {},
               systemRole: 'abc',
               tts: {} as any,
+              openingQuestions: [],
             },
             meta: {
               title: 'Session 1',
@@ -923,6 +939,8 @@ describe('ImporterService', () => {
                   enableAutoCreateTopic: true,
                   historyCount: 1,
                 },
+                openingQuestions: ['Question 1', 'Question 2'],
+                openingMessage: 'Hello, I am [LobeChat](https://github.com/lobehub/lobe-chat).',
               },
               group: 'XlUbvOvL',
               meta: {

package/src/services/session/server.test.ts

@@ -78,6 +78,8 @@ describe('ServerService', () => {
             openai: 'voice-id',
           },
         },
+        openingQuestions: ['Question 1', 'Question 2'],
+        openingMessage: 'Hello, I am [LobeChat](https://github.com/lobehub/lobe-chat).',
       },
       group: 'testGroup',
       meta: { description: 'test' },

package/src/store/agent/slices/chat/selectors/__snapshots__/agent.test.ts.snap

@@ -18,6 +18,7 @@ exports[`agentSelectors > defaultAgentConfig > should merge DEFAULT_AGENT_CONFIG
     "searchMode": "off",
   },
   "model": "gpt-3.5-turbo",
+  "openingQuestions": [],
   "params": {
     "frequency_penalty": 0,
     "presence_penalty": 0,

package/src/store/agent/slices/chat/selectors/agent.ts

@@ -7,6 +7,7 @@ import {
   DEFAULT_PROVIDER,
   DEFAUTT_AGENT_TTS_CONFIG,
 } from '@/const/settings';
+import { DEFAULT_OPENING_QUESTIONS } from '@/features/AgentSetting/store/selectors';
 import { AgentStoreState } from '@/store/agent/initialState';
 import { LobeAgentConfig, LobeAgentTTSConfig } from '@/types/agent';
 import { KnowledgeItem, KnowledgeType } from '@/types/knowledgeBase';
@@ -138,6 +139,10 @@ const currentKnowledgeIds = (s: AgentStoreState) => {
 
 const isAgentConfigLoading = (s: AgentStoreState) => !s.agentConfigInitMap[s.activeId];
 
+const openingQuestions = (s: AgentStoreState) =>
+  currentAgentConfig(s).openingQuestions || DEFAULT_OPENING_QUESTIONS;
+const openingMessage = (s: AgentStoreState) => currentAgentConfig(s).openingMessage || '';
+
 export const agentSelectors = {
   currentAgentConfig,
   currentAgentFiles,
@@ -158,4 +163,6 @@ export const agentSelectors = {
   inboxAgentModel,
   isAgentConfigLoading,
   isInboxSession,
+  openingMessage,
+  openingQuestions,
 };