Merge branch 'main' into v2

This commit is contained in:
fullex 2025-12-02 10:44:47 +08:00
commit d8790903cc
15 changed files with 177 additions and 67 deletions

View File

@ -27,6 +27,7 @@ import { buildAiSdkMiddlewares } from './middleware/AiSdkMiddlewareBuilder'
import { buildPlugins } from './plugins/PluginBuilder' import { buildPlugins } from './plugins/PluginBuilder'
import { createAiSdkProvider } from './provider/factory' import { createAiSdkProvider } from './provider/factory'
import { import {
adaptProvider,
getActualProvider, getActualProvider,
isModernSdkSupported, isModernSdkSupported,
prepareSpecialProviderConfig, prepareSpecialProviderConfig,
@ -64,12 +65,11 @@ export default class ModernAiProvider {
* - URL will be automatically formatted via `formatProviderApiHost`, adding version suffixes like `/v1` * - URL will be automatically formatted via `formatProviderApiHost`, adding version suffixes like `/v1`
* *
* 2. When called with `(model, provider)`: * 2. When called with `(model, provider)`:
* - **Directly uses the provided provider WITHOUT going through `getActualProvider`** * - The provided provider will be adapted via `adaptProvider`
* - **URL will NOT be automatically formatted, `/v1` suffix will NOT be added** * - URL formatting behavior depends on the adapted result
* - This is legacy behavior kept for backward compatibility
* *
* 3. When called with `(provider)`: * 3. When called with `(provider)`:
* - Directly uses the provider without requiring a model * - The provider will be adapted via `adaptProvider`
* - Used for operations that don't need a model (e.g., fetchModels) * - Used for operations that don't need a model (e.g., fetchModels)
* *
* @example * @example
@ -77,7 +77,7 @@ export default class ModernAiProvider {
* // Recommended: Auto-format URL * // Recommended: Auto-format URL
* const ai = new ModernAiProvider(model) * const ai = new ModernAiProvider(model)
* *
* // Not recommended: Skip URL formatting (only for special cases) * // Provider will be adapted
* const ai = new ModernAiProvider(model, customProvider) * const ai = new ModernAiProvider(model, customProvider)
* *
* // For operations that don't need a model * // For operations that don't need a model
@ -91,12 +91,12 @@ export default class ModernAiProvider {
if (this.isModel(modelOrProvider)) { if (this.isModel(modelOrProvider)) {
// 传入的是 Model // 传入的是 Model
this.model = modelOrProvider this.model = modelOrProvider
this.actualProvider = provider || getActualProvider(modelOrProvider) this.actualProvider = provider ? adaptProvider({ provider }) : getActualProvider(modelOrProvider)
// 只保存配置不预先创建executor // 只保存配置不预先创建executor
this.config = providerToAiSdkConfig(this.actualProvider, modelOrProvider) this.config = providerToAiSdkConfig(this.actualProvider, modelOrProvider)
} else { } else {
// 传入的是 Provider // 传入的是 Provider
this.actualProvider = modelOrProvider this.actualProvider = adaptProvider({ provider: modelOrProvider })
// model为可选某些操作如fetchModels不需要model // model为可选某些操作如fetchModels不需要model
} }

View File

@ -79,11 +79,13 @@ function handleSpecialProviders(model: Model, provider: Provider): Provider {
} }
/** /**
* AISdk的BaseURL格式 * Format and normalize the API host URL for a provider.
* @param provider * Handles provider-specific URL formatting rules (e.g., appending version paths, Azure formatting).
* @returns *
* @param provider - The provider whose API host is to be formatted.
* @returns A new provider instance with the formatted API host.
*/ */
function formatProviderApiHost(provider: Provider): Provider { export function formatProviderApiHost(provider: Provider): Provider {
const formatted = { ...provider } const formatted = { ...provider }
if (formatted.anthropicApiHost) { if (formatted.anthropicApiHost) {
formatted.anthropicApiHost = formatApiHost(formatted.anthropicApiHost) formatted.anthropicApiHost = formatApiHost(formatted.anthropicApiHost)
@ -115,18 +117,38 @@ function formatProviderApiHost(provider: Provider): Provider {
} }
/** /**
* Provider配置 * Retrieve the effective Provider configuration for the given model.
* * Applies all necessary transformations (special-provider handling, URL formatting, etc.).
*
* @param model - The model whose provider is to be resolved.
* @returns A new Provider instance with all adaptations applied.
*/ */
export function getActualProvider(model: Model): Provider { export function getActualProvider(model: Model): Provider {
const baseProvider = getProviderByModel(model) const baseProvider = getProviderByModel(model)
// 按顺序处理各种转换 return adaptProvider({ provider: baseProvider, model })
let actualProvider = cloneDeep(baseProvider) }
actualProvider = handleSpecialProviders(model, actualProvider)
actualProvider = formatProviderApiHost(actualProvider)
return actualProvider /**
* Transforms a provider configuration by applying model-specific adaptations and normalizing its API host.
* The transformations are applied in the following order:
* 1. Model-specific provider handling (e.g., New-API, system providers, Azure OpenAI)
* 2. API host formatting (provider-specific URL normalization)
*
* @param provider - The base provider configuration to transform.
* @param model - The model associated with the provider; optional but required for special-provider handling.
* @returns A new Provider instance with all transformations applied.
*/
export function adaptProvider({ provider, model }: { provider: Provider; model?: Model }): Provider {
let adaptedProvider = cloneDeep(provider)
// Apply transformations in order
if (model) {
adaptedProvider = handleSpecialProviders(model, adaptedProvider)
}
adaptedProvider = formatProviderApiHost(adaptedProvider)
return adaptedProvider
} }
/** /**

View File

@ -4372,7 +4372,7 @@
"url": { "url": {
"preview": "Preview: {{url}}", "preview": "Preview: {{url}}",
"reset": "Reset", "reset": "Reset",
"tip": "ending with # forces use of input address" "tip": "Add # at the end to disable the automatically appended API version."
} }
}, },
"api_host": "API Host", "api_host": "API Host",

View File

@ -4372,7 +4372,7 @@
"url": { "url": {
"preview": "预览: {{url}}", "preview": "预览: {{url}}",
"reset": "重置", "reset": "重置",
"tip": "# 结尾强制使用输入地址" "tip": "在末尾添加 # 以禁用自动附加的API版本。"
} }
}, },
"api_host": "API 地址", "api_host": "API 地址",

View File

@ -4372,7 +4372,7 @@
"url": { "url": {
"preview": "預覽:{{url}}", "preview": "預覽:{{url}}",
"reset": "重設", "reset": "重設",
"tip": "# 結尾強制使用輸入位址" "tip": "在末尾添加 # 以停用自動附加的 API 版本。"
} }
}, },
"api_host": "API 主機地址", "api_host": "API 主機地址",

View File

@ -4372,7 +4372,7 @@
"url": { "url": {
"preview": "Vorschau: {{url}}", "preview": "Vorschau: {{url}}",
"reset": "Zurücksetzen", "reset": "Zurücksetzen",
"tip": "# am Ende erzwingt die Verwendung der Eingabe-Adresse" "tip": "Fügen Sie am Ende ein # hinzu, um die automatisch angehängte API-Version zu deaktivieren."
} }
}, },
"api_host": "API-Adresse", "api_host": "API-Adresse",

View File

@ -4372,7 +4372,7 @@
"url": { "url": {
"preview": "Προεπισκόπηση: {{url}}", "preview": "Προεπισκόπηση: {{url}}",
"reset": "Επαναφορά", "reset": "Επαναφορά",
"tip": "#τέλος ενδεχόμενη χρήση της εισαγωγής διευθύνσεως" "tip": "Προσθέστε το σύμβολο # στο τέλος για να απενεργοποιήσετε την αυτόματα προστιθέμενη έκδοση API."
} }
}, },
"api_host": "Διεύθυνση API", "api_host": "Διεύθυνση API",

View File

@ -4372,7 +4372,7 @@
"url": { "url": {
"preview": "Vista previa: {{url}}", "preview": "Vista previa: {{url}}",
"reset": "Restablecer", "reset": "Restablecer",
"tip": "forzar uso de dirección de entrada con # al final" "tip": "Añada # al final para deshabilitar la versión de la API que se añade automáticamente."
} }
}, },
"api_host": "Dirección API", "api_host": "Dirección API",

View File

@ -4372,7 +4372,7 @@
"url": { "url": {
"preview": "Aperçu : {{url}}", "preview": "Aperçu : {{url}}",
"reset": "Réinitialiser", "reset": "Réinitialiser",
"tip": "forcer l'utilisation de l'adresse d'entrée si terminé par #" "tip": "Ajoutez # à la fin pour désactiver la version d'API ajoutée automatiquement."
} }
}, },
"api_host": "Adresse API", "api_host": "Adresse API",

View File

@ -4372,7 +4372,7 @@
"url": { "url": {
"preview": "プレビュー: {{url}}", "preview": "プレビュー: {{url}}",
"reset": "リセット", "reset": "リセット",
"tip": "#で終わる場合、入力されたアドレスを強制的に使用します" "tip": "自動的に付加されるAPIバージョンを無効にするには、末尾に#を追加します。"
} }
}, },
"api_host": "APIホスト", "api_host": "APIホスト",

View File

@ -4372,7 +4372,7 @@
"url": { "url": {
"preview": "Pré-visualização: {{url}}", "preview": "Pré-visualização: {{url}}",
"reset": "Redefinir", "reset": "Redefinir",
"tip": "e forçar o uso do endereço original quando terminar com '#'" "tip": "Adicione # no final para desativar a versão da API adicionada automaticamente."
} }
}, },
"api_host": "Endereço API", "api_host": "Endereço API",

View File

@ -4372,7 +4372,7 @@
"url": { "url": {
"preview": "Предпросмотр: {{url}}", "preview": "Предпросмотр: {{url}}",
"reset": "Сброс", "reset": "Сброс",
"tip": "заканчивая на # принудительно использует введенный адрес" "tip": "Добавьте # в конце, чтобы отключить автоматически добавляемую версию API."
} }
}, },
"api_host": "Хост API", "api_host": "Хост API",

View File

@ -1,8 +1,10 @@
import { Button, Flex, RowFlex, Switch, Tooltip, WarnTooltip } from '@cherrystudio/ui' import { Button, Flex, RowFlex, Switch, Tooltip, WarnTooltip } from '@cherrystudio/ui'
import { adaptProvider } from '@renderer/aiCore/provider/providerConfig'
import OpenAIAlert from '@renderer/components/Alert/OpenAIAlert' import OpenAIAlert from '@renderer/components/Alert/OpenAIAlert'
import { LoadingIcon } from '@renderer/components/Icons' import { LoadingIcon } from '@renderer/components/Icons'
import { ApiKeyListPopup } from '@renderer/components/Popups/ApiKeyListPopup' import { ApiKeyListPopup } from '@renderer/components/Popups/ApiKeyListPopup'
import Selector from '@renderer/components/Selector' import Selector from '@renderer/components/Selector'
import { HelpTooltip } from '@renderer/components/TooltipIcons'
import { isEmbeddingModel, isRerankModel } from '@renderer/config/models' import { isEmbeddingModel, isRerankModel } from '@renderer/config/models'
import { PROVIDER_URLS } from '@renderer/config/providers' import { PROVIDER_URLS } from '@renderer/config/providers'
import { useTheme } from '@renderer/context/ThemeProvider' import { useTheme } from '@renderer/context/ThemeProvider'
@ -19,14 +21,7 @@ import type { SystemProviderId } from '@renderer/types'
import { isSystemProvider, isSystemProviderId, SystemProviderIds } from '@renderer/types' import { isSystemProvider, isSystemProviderId, SystemProviderIds } from '@renderer/types'
import type { ApiKeyConnectivity } from '@renderer/types/healthCheck' import type { ApiKeyConnectivity } from '@renderer/types/healthCheck'
import { HealthStatus } from '@renderer/types/healthCheck' import { HealthStatus } from '@renderer/types/healthCheck'
import { import { formatApiHost, formatApiKeys, getFancyProviderName, validateApiHost } from '@renderer/utils'
formatApiHost,
formatApiKeys,
formatAzureOpenAIApiHost,
formatVertexApiHost,
getFancyProviderName,
validateApiHost
} from '@renderer/utils'
import { formatErrorMessage } from '@renderer/utils/error' import { formatErrorMessage } from '@renderer/utils/error'
import { import {
isAIGatewayProvider, isAIGatewayProvider,
@ -36,7 +31,6 @@ import {
isNewApiProvider, isNewApiProvider,
isOpenAICompatibleProvider, isOpenAICompatibleProvider,
isOpenAIProvider, isOpenAIProvider,
isSupportAPIVersionProvider,
isVertexProvider isVertexProvider
} from '@renderer/utils/provider' } from '@renderer/utils/provider'
import { Divider, Input, Select, Space } from 'antd' import { Divider, Input, Select, Space } from 'antd'
@ -281,12 +275,10 @@ const ProviderSetting: FC<Props> = ({ providerId }) => {
}, [configuredApiHost, apiHost]) }, [configuredApiHost, apiHost])
const hostPreview = () => { const hostPreview = () => {
if (apiHost.endsWith('#')) { const formattedApiHost = adaptProvider({ provider: { ...provider, apiHost } }).apiHost
return apiHost.replace('#', '')
}
if (isOpenAICompatibleProvider(provider)) { if (isOpenAICompatibleProvider(provider)) {
return formatApiHost(apiHost, isSupportAPIVersionProvider(provider)) + '/chat/completions' return formattedApiHost + '/chat/completions'
} }
if (isAzureOpenAIProvider(provider)) { if (isAzureOpenAIProvider(provider)) {
@ -294,29 +286,26 @@ const ProviderSetting: FC<Props> = ({ providerId }) => {
const path = !['preview', 'v1'].includes(apiVersion) const path = !['preview', 'v1'].includes(apiVersion)
? `/v1/chat/completion?apiVersion=v1` ? `/v1/chat/completion?apiVersion=v1`
: `/v1/responses?apiVersion=v1` : `/v1/responses?apiVersion=v1`
return formatAzureOpenAIApiHost(apiHost) + path return formattedApiHost + path
} }
if (isAnthropicProvider(provider)) { if (isAnthropicProvider(provider)) {
// AI SDK uses the baseURL with /v1, then appends /messages return formattedApiHost + '/messages'
// formatApiHost adds /v1 automatically if not present
const normalizedHost = formatApiHost(apiHost)
return normalizedHost + '/messages'
} }
if (isGeminiProvider(provider)) { if (isGeminiProvider(provider)) {
return formatApiHost(apiHost, true, 'v1beta') + '/models' return formattedApiHost + '/models'
} }
if (isOpenAIProvider(provider)) { if (isOpenAIProvider(provider)) {
return formatApiHost(apiHost) + '/responses' return formattedApiHost + '/responses'
} }
if (isVertexProvider(provider)) { if (isVertexProvider(provider)) {
return formatVertexApiHost(provider) + '/publishers/google' return formattedApiHost + '/publishers/google'
} }
if (isAIGatewayProvider(provider)) { if (isAIGatewayProvider(provider)) {
return formatApiHost(apiHost) + '/language-model' return formattedApiHost + '/language-model'
} }
return formatApiHost(apiHost) return formattedApiHost
} }
// API key 连通性检查状态指示器,目前仅在失败时显示 // API key 连通性检查状态指示器,目前仅在失败时显示
@ -498,16 +487,21 @@ const ProviderSetting: FC<Props> = ({ providerId }) => {
{!isDmxapi && ( {!isDmxapi && (
<> <>
<SettingSubtitle style={{ display: 'flex', alignItems: 'center', justifyContent: 'space-between' }}> <SettingSubtitle style={{ display: 'flex', alignItems: 'center', justifyContent: 'space-between' }}>
<Tooltip title={hostSelectorTooltip} delay={300}> <div className="flex items-center gap-1">
<Selector <Tooltip title={hostSelectorTooltip} delay={300}>
size={14} <div>
value={activeHostField} <Selector
onChange={(value) => setActiveHostField(value as HostField)} size={14}
options={hostSelectorOptions} value={activeHostField}
style={{ paddingLeft: 1, fontWeight: 'bold' }} onChange={(value) => setActiveHostField(value as HostField)}
placement="bottomLeft" options={hostSelectorOptions}
/> style={{ paddingLeft: 1, fontWeight: 'bold' }}
</Tooltip> placement="bottomLeft"
/>
</div>
</Tooltip>
<HelpTooltip title={t('settings.provider.api.url.tip')}></HelpTooltip>
</div>
<Button variant="ghost" onClick={() => CustomHeaderPopup.show({ provider })} size="icon"> <Button variant="ghost" onClick={() => CustomHeaderPopup.show({ provider })} size="icon">
<Settings2 size={16} /> <Settings2 size={16} />
</Button> </Button>

View File

@ -13,7 +13,8 @@ import {
routeToEndpoint, routeToEndpoint,
splitApiKeyString, splitApiKeyString,
validateApiHost, validateApiHost,
withoutTrailingApiVersion withoutTrailingApiVersion,
withoutTrailingSharp
} from '../api' } from '../api'
vi.mock('@renderer/store', () => { vi.mock('@renderer/store', () => {
@ -81,6 +82,27 @@ describe('api', () => {
it('keeps host untouched when api version unsupported', () => { it('keeps host untouched when api version unsupported', () => {
expect(formatApiHost('https://api.example.com', false)).toBe('https://api.example.com') expect(formatApiHost('https://api.example.com', false)).toBe('https://api.example.com')
}) })
it('removes trailing # and does not append api version when host ends with #', () => {
expect(formatApiHost('https://api.example.com#')).toBe('https://api.example.com')
expect(formatApiHost('http://localhost:5173/#')).toBe('http://localhost:5173/')
expect(formatApiHost(' https://api.openai.com/# ')).toBe('https://api.openai.com/')
})
it('handles trailing # with custom api version settings', () => {
expect(formatApiHost('https://api.example.com#', true, 'v2')).toBe('https://api.example.com')
expect(formatApiHost('https://api.example.com#', false, 'v2')).toBe('https://api.example.com')
})
it('handles host with both trailing # and existing api version', () => {
expect(formatApiHost('https://api.example.com/v2#')).toBe('https://api.example.com/v2')
expect(formatApiHost('https://api.example.com/v3beta#')).toBe('https://api.example.com/v3beta')
})
it('trims whitespace before processing trailing #', () => {
expect(formatApiHost(' https://api.example.com# ')).toBe('https://api.example.com')
expect(formatApiHost('\thttps://api.example.com#\n')).toBe('https://api.example.com')
})
}) })
describe('hasAPIVersion', () => { describe('hasAPIVersion', () => {
@ -404,4 +426,56 @@ describe('api', () => {
expect(withoutTrailingApiVersion('')).toBe('') expect(withoutTrailingApiVersion('')).toBe('')
}) })
}) })
describe('withoutTrailingSharp', () => {
it('removes trailing # from URL', () => {
expect(withoutTrailingSharp('https://api.example.com#')).toBe('https://api.example.com')
expect(withoutTrailingSharp('http://localhost:3000#')).toBe('http://localhost:3000')
})
it('returns URL unchanged when no trailing #', () => {
expect(withoutTrailingSharp('https://api.example.com')).toBe('https://api.example.com')
expect(withoutTrailingSharp('http://localhost:3000')).toBe('http://localhost:3000')
})
it('handles URLs with multiple # characters but only removes trailing one', () => {
expect(withoutTrailingSharp('https://api.example.com#path#')).toBe('https://api.example.com#path')
})
it('handles URLs with # in the middle (not trailing)', () => {
expect(withoutTrailingSharp('https://api.example.com#section/path')).toBe('https://api.example.com#section/path')
expect(withoutTrailingSharp('https://api.example.com/v1/chat/completions#')).toBe(
'https://api.example.com/v1/chat/completions'
)
})
it('handles empty string', () => {
expect(withoutTrailingSharp('')).toBe('')
})
it('handles single character #', () => {
expect(withoutTrailingSharp('#')).toBe('')
})
it('preserves whitespace around the URL (pure function)', () => {
expect(withoutTrailingSharp(' https://api.example.com# ')).toBe(' https://api.example.com# ')
expect(withoutTrailingSharp('\thttps://api.example.com#\n')).toBe('\thttps://api.example.com#\n')
})
it('only removes exact trailing # character', () => {
expect(withoutTrailingSharp('https://api.example.com# ')).toBe('https://api.example.com# ')
expect(withoutTrailingSharp(' https://api.example.com#')).toBe(' https://api.example.com')
expect(withoutTrailingSharp('https://api.example.com#\t')).toBe('https://api.example.com#\t')
})
it('handles URLs ending with multiple # characters', () => {
expect(withoutTrailingSharp('https://api.example.com##')).toBe('https://api.example.com#')
expect(withoutTrailingSharp('https://api.example.com###')).toBe('https://api.example.com##')
})
it('preserves URL with trailing # and other content', () => {
expect(withoutTrailingSharp('https://api.example.com/v1#')).toBe('https://api.example.com/v1')
expect(withoutTrailingSharp('https://api.example.com/v2beta#')).toBe('https://api.example.com/v2beta')
})
})
}) })

View File

@ -62,6 +62,23 @@ export function withoutTrailingSlash<T extends string>(url: T): T {
return url.replace(/\/$/, '') as T return url.replace(/\/$/, '') as T
} }
/**
* Removes the trailing '#' from a URL string if it exists.
*
* @template T - The string type to preserve type safety
* @param {T} url - The URL string to process
* @returns {T} The URL string without a trailing '#'
*
* @example
* ```ts
* withoutTrailingSharp('https://example.com#') // 'https://example.com'
* withoutTrailingSharp('https://example.com') // 'https://example.com'
* ```
*/
export function withoutTrailingSharp<T extends string>(url: T): T {
return url.replace(/#$/, '') as T
}
/** /**
* Formats an API host URL by normalizing it and optionally appending an API version. * Formats an API host URL by normalizing it and optionally appending an API version.
* *
@ -70,12 +87,12 @@ export function withoutTrailingSlash<T extends string>(url: T): T {
* @param apiVersion - The API version to append if needed. Defaults to `'v1'`. * @param apiVersion - The API version to append if needed. Defaults to `'v1'`.
* *
* @returns The formatted API host URL. If the host is empty after normalization, returns an empty string. * @returns The formatted API host URL. If the host is empty after normalization, returns an empty string.
* If the host ends with '#', API version is not supported, or the host already contains a version, returns the normalized host as-is. * If the host ends with '#', API version is not supported, or the host already contains a version, returns the normalized host with trailing '#' removed.
* Otherwise, returns the host with the API version appended. * Otherwise, returns the host with the API version appended.
* *
* @example * @example
* formatApiHost('https://api.example.com/') // Returns 'https://api.example.com/v1' * formatApiHost('https://api.example.com/') // Returns 'https://api.example.com/v1'
* formatApiHost('https://api.example.com#') // Returns 'https://api.example.com#' * formatApiHost('https://api.example.com#') // Returns 'https://api.example.com'
* formatApiHost('https://api.example.com/v2', true, 'v1') // Returns 'https://api.example.com/v2' * formatApiHost('https://api.example.com/v2', true, 'v1') // Returns 'https://api.example.com/v2'
*/ */
export function formatApiHost(host?: string, supportApiVersion: boolean = true, apiVersion: string = 'v1'): string { export function formatApiHost(host?: string, supportApiVersion: boolean = true, apiVersion: string = 'v1'): string {
@ -84,10 +101,13 @@ export function formatApiHost(host?: string, supportApiVersion: boolean = true,
return '' return ''
} }
if (normalizedHost.endsWith('#') || !supportApiVersion || hasAPIVersion(normalizedHost)) { const shouldAppendApiVersion = !(normalizedHost.endsWith('#') || !supportApiVersion || hasAPIVersion(normalizedHost))
return normalizedHost
if (shouldAppendApiVersion) {
return `${normalizedHost}/${apiVersion}`
} else {
return withoutTrailingSharp(normalizedHost)
} }
return `${normalizedHost}/${apiVersion}`
} }
/** /**