feat: integrate web search results into UI (#624)

Signed-off-by: Bob Du <i@bobdu.cc>

Author: BobDu

service/src/chatgpt/index.ts

@@ -1,6 +1,6 @@
 import type { ClientOptions } from 'openai'
 import type { RequestInit } from 'undici'
-import type { AuditConfig, Config, KeyConfig, UserInfo } from '../storage/model'
+import type { AuditConfig, Config, KeyConfig, SearchResult, UserInfo } from '../storage/model'
 import type { TextAuditService } from '../utils/textAudit'
 import type { ChatMessage, RequestOptions } from './types'
 import { tavily } from '@tavily/core'
@@ -129,23 +129,42 @@ async function chatReplyProcess(options: RequestOptions) {
       if (searchQuery) {
         await updateChatSearchQuery(messageId, searchQuery)
 
+        process?.({
+          searchQuery,
+        })
+
         const tvly = tavily({ apiKey: searchConfig.options?.apiKey })
         const response = await tvly.search(
           searchQuery,
           {
             includeRawContent: true,
-            timeout: 300,
+            // 0 <= x <= 20 https://docs.tavily.com/documentation/api-reference/endpoint/search#body-max-results
+            maxResults: 20,
+            // Max 120s, default to 60 https://github.com/tavily-ai/tavily-js/blob/de69e479c5d3f6c5d443465fa2c29407c0d3515d/src/search.ts#L118
+            timeout: 120,
           },
         )
 
-        const searchResult = JSON.stringify(response)
-        await updateChatSearchResult(messageId, searchResult)
+        const searchResults = response.results as SearchResult[]
+        const searchUsageTime = response.responseTime
+
+        await updateChatSearchResult(messageId, searchResults, searchUsageTime)
+
+        process?.({
+          searchResults,
+          searchUsageTime,
+        })
+
+        let searchResultContent = JSON.stringify(searchResults)
+        // remove base64 image content
+        const base64Pattern = /data:image\/[a-zA-Z0-9+.-]+;base64,[A-Za-z0-9+/=]+/g
+        searchResultContent = searchResultContent.replace(base64Pattern, '')
 
         messages.push({
           role: 'user',
           content: `Additional information from web searche engine.
 search query: <search_query>${searchQuery}</search_query>
-search result: <search_result>${searchResult}</search_result>`,
+search result: <search_result>${searchResultContent}</search_result>`,
         })
 
         messages[0].content = renderSystemMessage(searchConfig.systemMessageWithSearchResult, dayjs().format('YYYY-MM-DD HH:mm:ss'))

service/src/chatgpt/types.ts

@@ -1,5 +1,5 @@
 import type OpenAI from 'openai'
-import type { ChatRoom, UserInfo } from 'src/storage/model'
+import type { ChatRoom, SearchResult, UserInfo } from 'src/storage/model'
 
 export interface ChatMessage {
   id: string
@@ -12,11 +12,14 @@ export interface ChatMessage {
 }
 
 export interface ResponseChunk {
-  id: string
-  text: string
-  reasoning: string
-  role: string
-  finish_reason: string
+  id?: string
+  searchQuery?: string
+  searchResults?: SearchResult[]
+  searchUsageTime?: number
+  text?: string
+  reasoning?: string
+  role?: string
+  finish_reason?: string
 }
 
 export interface RequestOptions {

service/src/routes/chat.ts

@@ -88,6 +88,9 @@ router.get('/chat-history', auth, async (req, res) => {
         result.push({
           uuid: c.uuid,
           dateTime: new Date(c.dateTime).toLocaleString(),
+          searchQuery: c.searchQuery,
+          searchResults: c.searchResults,
+          searchUsageTime: c.searchUsageTime,
           reasoning: c.reasoning,
           text: c.response,
           inversion: false,

service/src/storage/model.ts

@@ -117,6 +117,12 @@ export class previousResponse {
   options: ChatOptions
 }
 
+export class SearchResult {
+  title: string
+  url: string
+  content: string
+}
+
 export class ChatInfo {
   _id: ObjectId
   roomId: number
@@ -126,7 +132,8 @@ export class ChatInfo {
   prompt: string
   images?: string[]
   searchQuery?: string
-  searchResult?: string
+  searchResults?: SearchResult[]
+  searchUsageTime?: number
   reasoning?: string
   response?: string
   status: Status = Status.Normal

service/src/storage/mongo.ts

@@ -1,5 +1,14 @@
 import type { WithId } from 'mongodb'
-import type { AdvancedConfig, ChatOptions, Config, GiftCard, KeyConfig, UsageResponse, UserPrompt } from './model'
+import type {
+  AdvancedConfig,
+  ChatOptions,
+  Config,
+  GiftCard,
+  KeyConfig,
+  SearchResult,
+  UsageResponse,
+  UserPrompt,
+} from './model'
 import * as process from 'node:process'
 import dayjs from 'dayjs'
 import * as dotenv from 'dotenv'
@@ -125,11 +134,12 @@ export async function updateChatSearchQuery(chatId: string, searchQuery: string)
   return result.modifiedCount > 0
 }
 
-export async function updateChatSearchResult(chatId: string, searchResult: string) {
+export async function updateChatSearchResult(chatId: string, searchResults: SearchResult[], searchUsageTime: number) {
   const query = { _id: new ObjectId(chatId) }
   const update = {
     $set: {
-      searchResult,
+      searchResults,
+      searchUsageTime,
     },
   }
   const result = await chatCol.updateOne(query, update)

src/locales/en-US.ts

@@ -98,6 +98,12 @@ export default {
     reasoningProcess: 'Reasoning Process',
     noReasoningProcess: 'No Reasoning Process',
     expandCollapseReasoningProcess: 'Expand/Collapse Reasoning Process',
+    searching: 'Searching',
+    searchQuery: 'Search query',
+    searchResults: 'Search Results',
+    searchUsageTime: 'Search time',
+    noSearchResults: 'No Search Results',
+    expandCollapseSearchResults: 'Expand/Collapse Search Results',
   },
   setting: {
     overRide: 'Enable Override',

src/locales/ko-KR.ts

@@ -98,6 +98,12 @@ export default {
     reasoningProcess: '추론 과정',
     noReasoningProcess: '추론 과정 없음',
     expandCollapseReasoningProcess: '추론 과정 펼치기/접기',
+    searching: '검색 중',
+    searchQuery: '검색어',
+    searchResults: '검색 결과',
+    searchUsageTime: '검색 시간',
+    noSearchResults: '검색 결과 없음',
+    expandCollapseSearchResults: '검색 결과 펼치기/접기',
   },
   setting: {
     overRide: '덮어쓰기 활성화',

src/locales/zh-CN.ts

@@ -98,6 +98,12 @@ export default {
     reasoningProcess: '推理过程',
     noReasoningProcess: '无推理过程',
     expandCollapseReasoningProcess: '展开/折叠推理过程',
+    searching: '搜索中',
+    searchQuery: '搜索查询词',
+    searchResults: '搜索结果',
+    searchUsageTime: '搜索用时',
+    noSearchResults: '无搜索结果',
+    expandCollapseSearchResults: '展开/折叠搜索结果',
   },
   setting: {
     overRide: '开启覆写',

src/locales/zh-TW.ts

@@ -98,6 +98,12 @@ export default {
     reasoningProcess: '推理過程',
     noReasoningProcess: '無推理過程',
     expandCollapseReasoningProcess: '展開/收合推理過程',
+    searching: '搜尋中',
+    searchQuery: '搜尋詞',
+    searchResults: '搜尋結果',
+    searchUsageTime: '搜尋用時',
+    noSearchResults: '無搜尋結果',
+    expandCollapseSearchResults: '展開/收合搜尋結果',
   },
   setting: {
     overRide: '開啟覆寫',

src/typings/chat.d.ts

@@ -1,7 +1,16 @@
 declare namespace Chat {
+  interface SearchResult {
+    title: string
+    url: string
+    content: string
+  }
+
   interface Chat {
     uuid?: number
     dateTime: string
+    searchQuery?: string
+    searchResults?: SearchResult[]
+    searchUsageTime?: number
     reasoning?: string
     finish_reason?: string
     text: string