ouyang/cherry-studio
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactor: 将网络搜索参数用于模型内置搜索 (#10213)

Browse Source 
* Remove local provider option files and use external packages

Replace local implementation of XAI and OpenRouter provider options with
external packages (@ai-sdk/xai and @openrouter/ai-sdk-provider). Update
web search plugin to support additional providers including OpenAI Chat
and OpenRouter, with improved configuration mapping.

* Bump @cherrystudio/ai-core to v1.0.0-alpha.17

fix i18n

* fix(i18n): Auto update translations for PR #10213

---------

Co-authored-by: GitHub Action <action@github.com>
This commit is contained in:
SuYao
2025-09-17 15:10:30 +08:00
committed by GitHub
parent 1481149e51
commit a8bf55abc2
32 changed files with 359 additions and 173 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/renderer/src/aiCore/middleware/AiSdkMiddlewareBuilder.ts
+3
View File
@@ -1,3 +1,4 @@
import { WebSearchPluginConfig } from '@cherrystudio/ai-core/built-in/plugins'
import { loggerService } from '@logger'
import type { MCPTool, Message, Model, Provider } from '@renderer/types'
import type { Chunk } from '@renderer/types/chunk'
@@ -26,6 +27,8 @@ export interface AiSdkMiddlewareConfig {
enableUrlContext: boolean
mcpTools?: MCPTool[]
uiMessages?: Message[]
// 内置搜索配置
webSearchPluginConfig?: WebSearchPluginConfig
}
/**
src/renderer/src/aiCore/plugins/PluginBuilder.ts
+2 -3
View File
@@ -30,9 +30,8 @@ export function buildPlugins(
}
// 1. 模型内置搜索
if (middlewareConfig.enableWebSearch) {
// 内置了默认搜索参数，如果改的话可以传config进去
plugins.push(webSearchPlugin())
if (middlewareConfig.enableWebSearch && middlewareConfig.webSearchPluginConfig) {
plugins.push(webSearchPlugin(middlewareConfig.webSearchPluginConfig))
}
// 2. 支持工具调用时添加搜索插件
if (middlewareConfig.isSupportedToolUse || middlewareConfig.isPromptToolUse) {
src/renderer/src/aiCore/prepareParams/parameterBuilder.ts
+24 -3
View File
@@ -5,6 +5,8 @@
import { vertexAnthropic } from '@ai-sdk/google-vertex/anthropic/edge'
import { vertex } from '@ai-sdk/google-vertex/edge'
import { WebSearchPluginConfig } from '@cherrystudio/ai-core/built-in/plugins'
import { isBaseProvider } from '@cherrystudio/ai-core/core/providers/schemas'
import { loggerService } from '@logger'
import {
isGenerateImageModel,
@@ -16,8 +18,11 @@ import {
isWebSearchModel
} from '@renderer/config/models'
import { getAssistantSettings, getDefaultModel } from '@renderer/services/AssistantService'
import store from '@renderer/store'
import { CherryWebSearchConfig } from '@renderer/store/websearch'
import { type Assistant, type MCPTool, type Provider } from '@renderer/types'
import type { StreamTextParams } from '@renderer/types/aiCoreTypes'
import { mapRegexToPatterns } from '@renderer/utils/blacklistMatchPattern'
import type { ModelMessage, Tool } from 'ai'
import { stepCountIs } from 'ai'
@@ -25,6 +30,7 @@ import { getAiSdkProviderId } from '../provider/factory'
import { setupToolsConfig } from '../utils/mcp'
import { buildProviderOptions } from '../utils/options'
import { getAnthropicThinkingBudget } from '../utils/reasoning'
import { buildProviderBuiltinWebSearchConfig } from '../utils/websearch'
import { getTemperature, getTopP } from './modelParameters'
const logger = loggerService.withContext('parameterBuilder')
@@ -42,6 +48,7 @@ export async function buildStreamTextParams(
options: {
mcpTools?: MCPTool[]
webSearchProviderId?: string
webSearchConfig?: CherryWebSearchConfig
requestOptions?: {
signal?: AbortSignal
timeout?: number
@@ -57,6 +64,7 @@ export async function buildStreamTextParams(
enableGenerateImage: boolean
enableUrlContext: boolean
}
webSearchPluginConfig?: WebSearchPluginConfig
}> {
const { mcpTools } = options
@@ -93,6 +101,12 @@ export async function buildStreamTextParams(
// }
// 构建真正的 providerOptions
const webSearchConfig: CherryWebSearchConfig = {
maxResults: store.getState().websearch.maxResults,
excludeDomains: store.getState().websearch.excludeDomains,
searchWithTime: store.getState().websearch.searchWithTime
}
const providerOptions = buildProviderOptions(assistant, model, provider, {
enableReasoning,
enableWebSearch,
@@ -109,15 +123,21 @@ export async function buildStreamTextParams(
maxTokens -= getAnthropicThinkingBudget(assistant, model)
}
// google-vertex | google-vertex-anthropic
let webSearchPluginConfig: WebSearchPluginConfig | undefined = undefined
if (enableWebSearch) {
if (isBaseProvider(aiSdkProviderId)) {
webSearchPluginConfig = buildProviderBuiltinWebSearchConfig(aiSdkProviderId, webSearchConfig)
}
if (!tools) {
tools = {}
}
if (aiSdkProviderId === 'google-vertex') {
tools.google_search = vertex.tools.googleSearch({}) as ProviderDefinedTool
} else if (aiSdkProviderId === 'google-vertex-anthropic') {
tools.web_search = vertexAnthropic.tools.webSearch_20250305({}) as ProviderDefinedTool
tools.web_search = vertexAnthropic.tools.webSearch_20250305({
maxUses: webSearchConfig.maxResults,
blockedDomains: mapRegexToPatterns(webSearchConfig.excludeDomains)
}) as ProviderDefinedTool
}
}
@@ -151,7 +171,8 @@ export async function buildStreamTextParams(
return {
params,
modelId: model.id,
capabilities: { enableReasoning, enableWebSearch, enableGenerateImage, enableUrlContext }
capabilities: { enableReasoning, enableWebSearch, enableGenerateImage, enableUrlContext },
webSearchPluginConfig
}
}
src/renderer/src/aiCore/utils/websearch.ts
+81 -7
View File
@@ -1,6 +1,13 @@
import {
AnthropicSearchConfig,
OpenAISearchConfig,
WebSearchPluginConfig
} from '@cherrystudio/ai-core/core/plugins/built-in/webSearchPlugin/helper'
import { BaseProviderId } from '@cherrystudio/ai-core/provider'
import { isOpenAIWebSearchChatCompletionOnlyModel } from '@renderer/config/models'
import { WEB_SEARCH_PROMPT_FOR_OPENROUTER } from '@renderer/config/prompts'
import { CherryWebSearchConfig } from '@renderer/store/websearch'
import { Model } from '@renderer/types'
import { mapRegexToPatterns } from '@renderer/utils/blacklistMatchPattern'
export function getWebSearchParams(model: Model): Record<string, any> {
if (model.provider === 'hunyuan') {
@@ -21,11 +28,78 @@ export function getWebSearchParams(model: Model): Record<string, any> {
web_search_options: {}
}
}
if (model.provider === 'openrouter') {
return {
plugins: [{ id: 'web', search_prompts: WEB_SEARCH_PROMPT_FOR_OPENROUTER }]
}
}
return {}
}
/**
* range in [0, 100]
* @param maxResults
*/
function mapMaxResultToOpenAIContextSize(maxResults: number): OpenAISearchConfig['searchContextSize'] {
if (maxResults <= 33) return 'low'
if (maxResults <= 66) return 'medium'
return 'high'
}
export function buildProviderBuiltinWebSearchConfig(
providerId: BaseProviderId,
webSearchConfig: CherryWebSearchConfig
): WebSearchPluginConfig {
switch (providerId) {
case 'openai': {
return {
openai: {
searchContextSize: mapMaxResultToOpenAIContextSize(webSearchConfig.maxResults)
}
}
}
case 'openai-chat': {
return {
'openai-chat': {
searchContextSize: mapMaxResultToOpenAIContextSize(webSearchConfig.maxResults)
}
}
}
case 'anthropic': {
const anthropicSearchOptions: AnthropicSearchConfig = {
maxUses: webSearchConfig.maxResults,
blockedDomains: mapRegexToPatterns(webSearchConfig.excludeDomains)
}
return {
anthropic: anthropicSearchOptions
}
}
case 'xai': {
return {
xai: {
maxSearchResults: webSearchConfig.maxResults,
returnCitations: true,
sources: [
{
type: 'web',
excludedWebsites: mapRegexToPatterns(webSearchConfig.excludeDomains)
},
{ type: 'news' },
{ type: 'x' }
],
mode: 'on'
}
}
}
case 'openrouter': {
return {
openrouter: {
plugins: [
{
id: 'web',
max_results: webSearchConfig.maxResults
}
]
}
}
}
default: {
throw new Error(`Unsupported provider: ${providerId}`)
}
}
}
src/renderer/src/config/models/utils.ts
+5
View File
@@ -229,6 +229,11 @@ export const isGPT5SeriesModel = (model: Model) => {
return modelId.includes('gpt-5')
}
export const isGPT5SeriesReasoningModel = (model: Model) => {
const modelId = getLowerBaseModelName(model.id)
return modelId.includes('gpt-5') && !modelId.includes('chat')
}
export const isGeminiModel = (model: Model) => {
const modelId = getLowerBaseModelName(model.id)
return modelId.includes('gemini')
src/renderer/src/i18n/locales/en-us.json
+6 -1
View File
@@ -660,7 +660,12 @@
"title": "Topics",
"unpin": "Unpin Topic"
},
"translate": "Translate"
"translate": "Translate",
"web_search": {
"warning": {
"openai": "The GPT-5 model's minimal reasoning effort does not support web search."
}
}
},
"code": {
"auto_update_to_latest": "Automatically update to latest version",
src/renderer/src/i18n/locales/zh-cn.json
+6 -2
View File
@@ -132,7 +132,6 @@
},
"title": "API 服务器"
},
"assistants": {
"abbr": "助手",
"clear": {
@@ -661,7 +660,12 @@
"title": "话题",
"unpin": "取消固定"
},
"translate": "翻译"
"translate": "翻译",
"web_search": {
"warning": {
"openai": "GPT5 模型 minimal 思考强度不支持网络搜索"
}
}
},
"code": {
"auto_update_to_latest": "检查更新并安装最新版本",
src/renderer/src/i18n/locales/zh-tw.json
+6 -1
View File
@@ -660,7 +660,12 @@
"title": "話題",
"unpin": "取消固定"
},
"translate": "翻譯"
"translate": "翻譯",
"web_search": {
"warning": {
"openai": "GPT-5 模型的最小推理力度不支援網路搜尋。"
}
}
},
"code": {
"auto_update_to_latest": "檢查更新並安裝最新版本",
src/renderer/src/i18n/translate/el-gr.json
+8 -2
View File
@@ -362,8 +362,9 @@
"translate": "Μετάφραση στο {{target_language}}",
"translating": "Μετάφραση...",
"upload": {
"attachment": "Μεταφόρτωση συνημμένου",
"document": "Φόρτωση έγγραφου (το μοντέλο δεν υποστηρίζει εικόνες)",
"label": "Φόρτωση εικόνας ή έγγραφου",
"image_or_document": "Μεταφόρτωση εικόνας ή εγγράφου",
"upload_from_local": "Μεταφόρτωση αρχείου από τον υπολογιστή..."
},
"url_context": "Περιεχόμενο ιστοσελίδας",
@@ -659,7 +660,12 @@
"title": "Θέματα",
"unpin": "Ξεκαρφίτσωμα"
},
"translate": "Μετάφραση"
"translate": "Μετάφραση",
"web_search": {
"warning": {
"openai": "Το μοντέλο GPT5 με ελάχιστη ένταση σκέψης δεν υποστηρίζει αναζήτηση στο διαδίκτυο"
}
}
},
"code": {
"auto_update_to_latest": "Έλεγχος για ενημερώσεις και εγκατάσταση της τελευταίας έκδοσης",
src/renderer/src/i18n/translate/es-es.json
+8 -2
View File
@@ -362,8 +362,9 @@
"translate": "Traducir a {{target_language}}",
"translating": "Traduciendo...",
"upload": {
"attachment": "Subir archivo adjunto",
"document": "Subir documento (el modelo no admite imágenes)",
"label": "Subir imagen o documento",
"image_or_document": "Subir imagen o documento",
"upload_from_local": "Subir archivo local..."
},
"url_context": "Contexto de la página web",
@@ -659,7 +660,12 @@
"title": "Tema",
"unpin": "Quitar fijación"
},
"translate": "Traducir"
"translate": "Traducir",
"web_search": {
"warning": {
"openai": "El modelo GPT5 con intensidad de pensamiento mínima no admite búsqueda en la web."
}
}
},
"code": {
"auto_update_to_latest": "Comprobar actualizaciones e instalar la versión más reciente",
src/renderer/src/i18n/translate/fr-fr.json
+8 -2
View File
@@ -362,8 +362,9 @@
"translate": "Traduire en {{target_language}}",
"translating": "Traduction en cours...",
"upload": {
"attachment": "Télécharger la pièce jointe",
"document": "Télécharger un document (le modèle ne prend pas en charge les images)",
"label": "Télécharger une image ou un document",
"image_or_document": "Télécharger une image ou un document",
"upload_from_local": "Télécharger un fichier local..."
},
"url_context": "Contexte de la page web",
@@ -659,7 +660,12 @@
"title": "Sujet",
"unpin": "Annuler le fixage"
},
"translate": "Traduire"
"translate": "Traduire",
"web_search": {
"warning": {
"openai": "Le modèle GPT5 avec une intensité de réflexion minimale ne prend pas en charge la recherche sur Internet."
}
}
},
"code": {
"auto_update_to_latest": "Vérifier les mises à jour et installer la dernière version",
src/renderer/src/i18n/translate/ja-jp.json
+8 -2
View File
@@ -362,8 +362,9 @@
"translate": "{{target_language}}に翻訳",
"translating": "翻訳中...",
"upload": {
"attachment": "添付ファイルをアップロード",
"document": "ドキュメントをアップロード（モデルは画像をサポートしません）",
"label": "画像またはドキュメントをアップロード",
"image_or_document": "画像またはドキュメントをアップロード",
"upload_from_local": "ローカルファイルをアップロード..."
},
"url_context": "URLコンテキスト",
@@ -659,7 +660,12 @@
"title": "トピック",
"unpin": "固定解除"
},
"translate": "翻訳"
"translate": "翻訳",
"web_search": {
"warning": {
"openai": "GPT5モデルの最小思考強度ではネット検索はサポートされません"
}
}
},
"code": {
"auto_update_to_latest": "最新バージョンを自動的に更新する",
src/renderer/src/i18n/translate/pt-pt.json
+8 -2
View File
@@ -362,8 +362,9 @@
"translate": "Traduzir para {{target_language}}",
"translating": "Traduzindo...",
"upload": {
"attachment": "Carregar anexo",
"document": "Carregar documento (o modelo não suporta imagens)",
"label": "Carregar imagem ou documento",
"image_or_document": "Carregar imagem ou documento",
"upload_from_local": "Fazer upload de arquivo local..."
},
"url_context": "Contexto da Página da Web",
@@ -659,7 +660,12 @@
"title": "Tópicos",
"unpin": "Desfixar"
},
"translate": "Traduzir"
"translate": "Traduzir",
"web_search": {
"warning": {
"openai": "O modelo GPT5 com intensidade mínima de pensamento não suporta pesquisa na web"
}
}
},
"code": {
"auto_update_to_latest": "Verificar atualizações e instalar a versão mais recente",
src/renderer/src/i18n/translate/ru-ru.json
+8 -2
View File
@@ -362,8 +362,9 @@
"translate": "Перевести на {{target_language}}",
"translating": "Перевод...",
"upload": {
"attachment": "Загрузить вложение",
"document": "Загрузить документ (модель не поддерживает изображения)",
"label": "Загрузить изображение или документ",
"image_or_document": "Загрузить изображение или документ",
"upload_from_local": "Загрузить локальный файл..."
},
"url_context": "Контекст страницы",
@@ -659,7 +660,12 @@
"title": "Топики",
"unpin": "Открепленные темы"
},
"translate": "Перевести"
"translate": "Перевести",
"web_search": {
"warning": {
"openai": "Модель GPT5 с минимальной интенсивностью мышления не поддерживает поиск в интернете"
}
}
},
"code": {
"auto_update_to_latest": "Автоматически обновлять до последней версии",
src/renderer/src/pages/home/Inputbar/ThinkingButton.tsx
+17 -2
View File
@@ -8,7 +8,13 @@ import {
MdiLightbulbOn80
} from '@renderer/components/Icons/SVGIcon'
import { QuickPanelReservedSymbol, useQuickPanel } from '@renderer/components/QuickPanel'
import { getThinkModelType, isDoubaoThinkingAutoModel, MODEL_SUPPORTED_OPTIONS } from '@renderer/config/models'
import {
getThinkModelType,
isDoubaoThinkingAutoModel,
isGPT5SeriesReasoningModel,
isOpenAIWebSearchModel,
MODEL_SUPPORTED_OPTIONS
} from '@renderer/config/models'
import { useAssistant } from '@renderer/hooks/useAssistant'
import { getReasoningEffortOptionsLabel } from '@renderer/i18n/label'
import { Model, ThinkingOption } from '@renderer/types'
@@ -61,6 +67,15 @@ const ThinkingButton: FC<Props> = ({ ref, model, assistantId }): ReactElement =>
})
return
}
if (
isOpenAIWebSearchModel(model) &&
isGPT5SeriesReasoningModel(model) &&
assistant.enableWebSearch &&
option === 'minimal'
) {
window.toast.warning(t('chat.web_search.warning.openai'))
return
}
updateAssistantSettings({
reasoning_effort: option,
reasoning_effort_cache: option,
@@ -68,7 +83,7 @@ const ThinkingButton: FC<Props> = ({ ref, model, assistantId }): ReactElement =>
})
return
},
[updateAssistantSettings]
[updateAssistantSettings, assistant.enableWebSearch, model, t]
)
const panelItems = useMemo(() => {
src/renderer/src/pages/home/Inputbar/WebSearchButton.tsx
+15 -1
View File
@@ -3,7 +3,12 @@ import { loggerService } from '@logger'
import { ActionIconButton } from '@renderer/components/Buttons'
import { BingLogo, BochaLogo, ExaLogo, SearXNGLogo, TavilyLogo, ZhipuLogo } from '@renderer/components/Icons'
import { QuickPanelListItem, QuickPanelReservedSymbol, useQuickPanel } from '@renderer/components/QuickPanel'
import { isGeminiModel, isWebSearchModel } from '@renderer/config/models'
import {
isGeminiModel,
isGPT5SeriesReasoningModel,
isOpenAIWebSearchModel,
isWebSearchModel
} from '@renderer/config/models'
import { isGeminiWebSearchProvider } from '@renderer/config/providers'
import { useAssistant } from '@renderer/hooks/useAssistant'
import { useTimer } from '@renderer/hooks/useTimer'
@@ -115,6 +120,15 @@ const WebSearchButton: FC<Props> = ({ ref, assistantId }) => {
update.enableWebSearch = false
window.toast.warning(t('chat.mcp.warning.gemini_web_search'))
}
if (
isOpenAIWebSearchModel(model) &&
isGPT5SeriesReasoningModel(model) &&
update.enableWebSearch &&
assistant.settings?.reasoning_effort === 'minimal'
) {
update.enableWebSearch = false
window.toast.warning(t('chat.web_search.warning.openai'))
}
setTimeoutTimer('updateSelectedWebSearchBuiltin', () => updateAssistant(update), 200)
}, [assistant, setTimeoutTimer, t, updateAssistant])
src/renderer/src/services/ApiService.ts
+3 -1
View File
@@ -117,7 +117,8 @@ export async function fetchChatCompletion({
const {
params: aiSdkParams,
modelId,
capabilities
capabilities,
webSearchPluginConfig
} = await buildStreamTextParams(messages, assistant, provider, {
mcpTools: mcpTools,
webSearchProviderId: assistant.webSearchProviderId,
@@ -132,6 +133,7 @@ export async function fetchChatCompletion({
isPromptToolUse: isPromptToolUse(assistant),
isSupportedToolUse: isSupportedToolUse(assistant),
isImageGenerationEndpoint: isDedicatedImageGenerationModel(assistant.model || getDefaultModel()),
webSearchPluginConfig: webSearchPluginConfig,
enableWebSearch: capabilities.enableWebSearch,
enableGenerateImage: capabilities.enableGenerateImage,
enableUrlContext: capabilities.enableUrlContext,
src/renderer/src/store/websearch.ts
+2
View File
@@ -41,6 +41,8 @@ export interface WebSearchState {
providerConfig: Record<string, any>
}
export type CherryWebSearchConfig = Pick<WebSearchState, 'searchWithTime' | 'maxResults' | 'excludeDomains'>
export const initialState: WebSearchState = {
defaultProvider: 'local-bing',
providers: WEB_SEARCH_PROVIDERS,
src/renderer/src/utils/__tests__/blacklistMatchPattern.test.ts
+26 -1
View File
@@ -26,7 +26,7 @@
import { describe, expect, it } from 'vitest'
import { MatchPatternMap } from '../blacklistMatchPattern'
import { mapRegexToPatterns, MatchPatternMap } from '../blacklistMatchPattern'
function get(map: MatchPatternMap<number>, url: string) {
return map.get(url).sort()
@@ -161,3 +161,28 @@ describe('blacklistMatchPattern', () => {
expect(get(map, 'https://b.mozilla.org/path/')).toEqual([0, 1, 2, 6])
})
})
describe('mapRegexToPatterns', () => {
it('extracts domains from regex patterns', () => {
const result = mapRegexToPatterns([
'/example\\.com/',
'/(?:www\\.)?sub\\.example\\.co\\.uk/',
'/api\\.service\\.io/',
'https://baidu.com'
])
expect(result).toEqual(['example.com', 'sub.example.co.uk', 'api.service.io', 'baidu.com'])
})
it('deduplicates domains across multiple patterns', () => {
const result = mapRegexToPatterns(['/example\\.com/', '/(example\\.com|test\\.org)/'])
expect(result).toEqual(['example.com', 'test.org'])
})
it('ignores patterns without domain matches', () => {
const result = mapRegexToPatterns(['', 'plain-domain.com', '/^https?:\\/\\/[^/]+$/'])
expect(result).toEqual(['plain-domain.com'])
})
})
src/renderer/src/utils/blacklistMatchPattern.ts
+37
View File
@@ -202,6 +202,43 @@ export async function parseSubscribeContent(url: string): Promise<string[]> {
throw error
}
}
export function mapRegexToPatterns(patterns: string[]): string[] {
const patternSet = new Set<string>()
const domainMatcher = /[A-Za-z0-9-]+(?:\.[A-Za-z0-9-]+)+/g
patterns.forEach((pattern) => {
if (!pattern) {
return
}
// Handle regex patterns (wrapped in /)
if (pattern.startsWith('/') && pattern.endsWith('/')) {
const rawPattern = pattern.slice(1, -1)
const normalizedPattern = rawPattern.replace(/\\\./g, '.').replace(/\\\//g, '/')
const matches = normalizedPattern.match(domainMatcher)
if (matches) {
matches.forEach((match) => {
patternSet.add(match.replace(/http(s)?:\/\//g, '').toLowerCase())
})
}
} else if (pattern.includes('://')) {
// Handle URLs with protocol (e.g., https://baidu.com)
const matches = pattern.match(domainMatcher)
if (matches) {
matches.forEach((match) => {
patternSet.add(match.replace(/http(s)?:\/\//g, '').toLowerCase())
})
}
} else {
patternSet.add(pattern.toLowerCase())
}
})
return Array.from(patternSet)
}
export async function filterResultWithBlacklist(
response: WebSearchProviderResponse,
websearch: WebSearchState