feat: add search api provider and api key config page

Signed-off-by: Bob Du <[email protected]>

Author: BobDu

service/src/index.ts

@@ -781,6 +781,33 @@ router.post('/audit-test', rootAuth, async (req, res) => {
   }
 })
 
+router.post('/setting-search', rootAuth, async (req, res) => {
+  try {
+    const config = req.body as import('./storage/model').SearchConfig
+
+    const thisConfig = await getOriginConfig()
+    thisConfig.searchConfig = config
+    const result = await updateConfig(thisConfig)
+    clearConfigCache()
+    res.send({ status: 'Success', message: '操作成功 | Successfully', data: result.searchConfig })
+  }
+  catch (error) {
+    res.send({ status: 'Fail', message: error.message, data: null })
+  }
+})
+
+router.post('/search-test', rootAuth, async (req, res) => {
+  try {
+    const { search, text } = req.body as { search: import('./storage/model').SearchConfig; text: string }
+    // TODO: Implement actual search test logic with Tavily API
+    // For now, just return a success response
+    res.send({ status: 'Success', message: '搜索测试成功 | Search test successful', data: { query: text, results: [] } })
+  }
+  catch (error) {
+    res.send({ status: 'Fail', message: error.message, data: null })
+  }
+})
+
 router.post('/setting-advanced', auth, async (req, res) => {
   try {
     const config = req.body as {

service/src/storage/config.ts

@@ -2,7 +2,7 @@ import { ObjectId } from 'mongodb'
 import * as dotenv from 'dotenv'
 import type { TextAuditServiceProvider } from 'src/utils/textAudit'
 import { isNotEmptyString, isTextAuditServiceProvider } from '../utils/is'
-import { AdvancedConfig, AnnounceConfig, AuditConfig, Config, KeyConfig, MailConfig, SiteConfig, TextAudioType, UserRole } from './model'
+import { AdvancedConfig, AnnounceConfig, AuditConfig, Config, KeyConfig, MailConfig, SearchConfig, SiteConfig, TextAudioType, UserRole } from './model'
 import { getConfig, getKeys, upsertKey } from './mongo'
 
 dotenv.config()
@@ -110,6 +110,11 @@ export async function getOriginConfig() {
     )
   }
 
+  if (!config.searchConfig) {
+    config.searchConfig = new SearchConfig()
+    config.searchConfig.enabled = false
+  }
+
   if (!isNotEmptyString(config.siteConfig.chatModels))
     config.siteConfig.chatModels = 'gpt-4.1,gpt-4.1-mini,gpt-4.1-nano'
   return config

service/src/storage/model.ts

@@ -171,6 +171,20 @@ export class ChatUsage {
   }
 }
 
+export class SearchConfig {
+  public enabled: boolean
+  public provider?: SearchServiceProvider
+  public options?: SearchServiceOptions
+}
+
+export enum SearchServiceProvider {
+  Tavily = 'tavily',
+}
+
+export class SearchServiceOptions {
+  public apiKey: string
+}
+
 export class Config {
   constructor(
     public _id: ObjectId,
@@ -187,6 +201,7 @@ export class Config {
     public siteConfig?: SiteConfig,
     public mailConfig?: MailConfig,
     public auditConfig?: AuditConfig,
+    public searchConfig?: SearchConfig,
     public advancedConfig?: AdvancedConfig,
     public announceConfig?: AnnounceConfig,
   ) { }

src/api/index.ts

@@ -1,6 +1,6 @@
 import type { AxiosProgressEvent, GenericAbortSignal } from 'axios'
 import { get, post } from '@/utils/request'
-import type { AnnounceConfig, AuditConfig, ConfigState, GiftCard, KeyConfig, MailConfig, SiteConfig, Status, UserInfo, UserPassword, UserPrompt } from '@/components/common/Setting/model'
+import type { AnnounceConfig, AuditConfig, ConfigState, GiftCard, KeyConfig, MailConfig, SearchConfig, SiteConfig, Status, UserInfo, UserPassword, UserPrompt } from '@/components/common/Setting/model'
 import { useAuthStore, useUserStore } from '@/store'
 import type { SettingsState } from '@/store/modules/user/helper'
 
@@ -340,6 +340,20 @@ export function fetchTestAudit<T = any>(text: string, audit: AuditConfig) {
   })
 }
 
+export function fetchUpdateSearch<T = any>(search: SearchConfig) {
+  return post<T>({
+    url: '/setting-search',
+    data: search,
+  })
+}
+
+export function fetchTestSearch<T = any>(text: string, search: SearchConfig) {
+  return post<T>({
+    url: '/search-test',
+    data: { search, text },
+  })
+}
+
 export function fetchUpdateAnnounce<T = any>(announce: AnnounceConfig) {
   return post<T>({
     url: '/setting-announce',

src/components/common/Setting/Search.vue

@@ -0,0 +1,121 @@
+<script setup lang='ts'>
+import { onMounted, ref } from 'vue'
+import { NButton, NInput, NSelect, NSpin, NSwitch, useMessage } from 'naive-ui'
+import type { ConfigState, SearchConfig, SearchServiceProvider } from './model'
+import { fetchChatConfig, fetchTestSearch, fetchUpdateSearch } from '@/api'
+import { t } from '@/locales'
+
+const ms = useMessage()
+
+const loading = ref(false)
+const saving = ref(false)
+const testing = ref(false)
+const testText = ref<string>('What is the latest news about artificial intelligence?')
+
+const serviceOptions: { label: string; key: SearchServiceProvider; value: SearchServiceProvider }[] = [
+  { label: 'Tavily', key: 'tavily', value: 'tavily' },
+]
+
+const config = ref<SearchConfig>()
+
+async function fetchConfig() {
+  try {
+    loading.value = true
+    const { data } = await fetchChatConfig<ConfigState>()
+    config.value = data.searchConfig
+  }
+  finally {
+    loading.value = false
+  }
+}
+
+async function updateSearchInfo() {
+  saving.value = true
+  try {
+    const { data } = await fetchUpdateSearch(config.value as SearchConfig)
+    config.value = data
+    ms.success(t('common.success'))
+  }
+  catch (error: any) {
+    ms.error(error.message)
+  }
+  saving.value = false
+}
+
+async function testSearch() {
+  testing.value = true
+  try {
+    const { message } = await fetchTestSearch(testText.value as string, config.value as SearchConfig) as { status: string; message: string }
+    ms.success(message)
+  }
+  catch (error: any) {
+    ms.error(error.message)
+  }
+  testing.value = false
+}
+
+onMounted(() => {
+  fetchConfig()
+})
+</script>
+
+<template>
+  <NSpin :show="loading">
+    <div class="p-4 space-y-5 min-h-[200px]">
+      <div class="space-y-6">
+        <div class="flex items-center space-x-4">
+          <span class="flex-shrink-0 w-[100px]">{{ $t('setting.searchEnabled') }}</span>
+          <div class="flex-1">
+            <NSwitch
+              :round="false" :value="config && config.enabled"
+              @update:value="(val) => { if (config) config.enabled = val }"
+            />
+          </div>
+        </div>
+        <div v-if="config && config.enabled" class="flex items-center space-x-4">
+          <span class="flex-shrink-0 w-[100px]">{{ $t('setting.searchProvider') }}</span>
+          <div class="flex-1">
+            <NSelect
+              style="width: 140px"
+              :value="config && config.provider"
+              :options="serviceOptions"
+              @update-value="(val) => { if (config) config.provider = val as SearchServiceProvider }"
+            />
+          </div>
+        </div>
+        <div v-if="config && config.enabled" class="flex items-center space-x-4">
+          <span class="flex-shrink-0 w-[100px]">{{ $t('setting.searchApiKey') }}</span>
+          <div class="flex-1">
+            <NInput
+              :value="config && config.options && config.options.apiKey"
+              placeholder=""
+              type="password"
+              show-password-on="click"
+              @input="(val) => { if (config && config.options) config.options.apiKey = val }"
+            />
+          </div>
+        </div>
+        <div v-if="config && config.enabled" class="flex items-center space-x-4">
+          <span class="flex-shrink-0 w-[100px]">{{ $t('setting.searchTest') }}</span>
+          <div class="flex-1">
+            <NInput
+              v-model:value="testText"
+              placeholder=""
+            />
+          </div>
+        </div>
+        <div class="flex items-center space-x-4">
+          <span class="flex-shrink-0 w-[100px]" />
+          <div class="flex flex-wrap items-center gap-4">
+            <NButton :loading="saving" type="primary" @click="updateSearchInfo()">
+              {{ $t('common.save') }}
+            </NButton>
+            <NButton :loading="testing" type="info" @click="testSearch()">
+              {{ $t('common.test') }}
+            </NButton>
+          </div>
+        </div>
+      </div>
+    </div>
+  </NSpin>
+</template>

src/components/common/Setting/index.vue

@@ -8,6 +8,7 @@ import About from './About.vue'
 import Site from './Site.vue'
 import Mail from './Mail.vue'
 import Audit from './Audit.vue'
+import Search from './Search.vue'
 import Gift from './Gift.vue'
 import User from './User.vue'
 import Key from './Keys.vue'
@@ -143,6 +144,13 @@ const show = computed({
           </template>
           <Audit />
         </NTabPane>
+        <NTabPane v-if="userStore.userInfo.root" name="SearchConfig" tab="SearchConfig">
+          <template #tab>
+            <SvgIcon class="text-lg" icon="mdi:web" />
+            <span class="ml-2">{{ $t('setting.searchConfig') }}</span>
+          </template>
+          <Search />
+        </NTabPane>
         <NTabPane v-if="userStore.userInfo.root" name="UserConfig" tab="UserConfig">
           <template #tab>
             <SvgIcon class="text-lg" icon="ri-user-5-line" />

src/components/common/Setting/model.ts

@@ -13,6 +13,7 @@ export class ConfigState {
   siteConfig?: SiteConfig
   mailConfig?: MailConfig
   auditConfig?: AuditConfig
+  searchConfig?: SearchConfig
   announceConfig?: AnnounceConfig
 }
 
@@ -180,3 +181,15 @@ export interface GiftCard {
   amount: number
   redeemed: number
 }
+
+export type SearchServiceProvider = 'tavily'
+
+export interface SearchServiceOptions {
+  apiKey: string
+}
+
+export class SearchConfig {
+  enabled?: boolean
+  provider?: SearchServiceProvider
+  options?: SearchServiceOptions
+}

src/locales/en-US.ts

@@ -110,6 +110,7 @@ export default {
     siteConfig: 'Site Config',
     mailConfig: 'Mail Config',
     auditConfig: 'Audit Config',
+    searchConfig: 'Search Config',
     avatarLink: 'Avatar Link',
     name: 'Name',
     description: 'Description',
@@ -163,6 +164,10 @@ export default {
     auditBaiduLabelLink: 'Goto Label Detail',
     auditCustomizeEnabled: 'Customize',
     auditCustomizeWords: 'Sensitive Words',
+    searchEnabled: 'Search Enabled',
+    searchProvider: 'Search Provider',
+    searchApiKey: 'Search API Key',
+    searchTest: 'Test Search',
     accessTokenExpiredTime: 'Expired Time',
     userConfig: 'Users',
     keysConfig: 'Keys Manager',

src/locales/zh-CN.ts

@@ -110,6 +110,7 @@ export default {
     siteConfig: '网站配置',
     mailConfig: '邮箱配置',
     auditConfig: '敏感词审核',
+    searchConfig: '搜索配置',
     avatarLink: '头像链接',
     name: '名称',
     description: '描述',
@@ -163,6 +164,10 @@ export default {
     auditBaiduLabelLink: '查看细分类型',
     auditCustomizeEnabled: '自定义',
     auditCustomizeWords: '敏感词',
+    searchEnabled: '搜索功能',
+    searchProvider: '搜索提供商',
+    searchApiKey: '搜索 API 密钥',
+    searchTest: '测试搜索',
     accessTokenExpiredTime: '过期时间',
     userConfig: '用户管理',
     keysConfig: 'Keys 管理',