Skip to content

feat(zai): consolidate to two coding entrypoints and update endpoints/tests/UI #8162

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 4 commits into from
Closed

feat(zai): consolidate to two coding entrypoints and update endpoints/tests/UI #8162

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7bc7291
feat(zai): consolidate to two coding entrypoints (International/China…
hannesrudolph Sep 18, 2025
3ad654d
i18n(zai): localize entrypoint labels and model descriptions; use i18…
hannesrudolph Sep 18, 2025
ea48d53
feat(i18n): add entrypoint options and model descriptions for multipl…
hannesrudolph Sep 19, 2025
023ea9a
fix: improve handling of dotted keys in getValueAtPath function
hannesrudolph Sep 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/types/src/provider-settings.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -376,7 +376,7 @@ const sambaNovaSchema = apiModelIdProviderModelSchema.extend({
sambaNovaApiKey: z.string().optional(),
})

export const zaiApiLineSchema = z.enum(["international_coding", "international", "china_coding", "china"])
export const zaiApiLineSchema = z.enum(["international", "china"])

export type ZaiApiLine = z.infer<typeof zaiApiLineSchema>

Expand Down
8 changes: 3 additions & 5 deletions packages/types/src/providers/zai.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,12 +106,10 @@ export const mainlandZAiModels = {
export const ZAI_DEFAULT_TEMPERATURE = 0

export const zaiApiLineConfigs = {
international_coding: {
name: "International Coding Plan",
international: {
name: "International",
Copy link
Contributor

@roomote roomote bot Sep 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the naming convention intentional where the enum uses lowercase 'international' and 'china' but the display names are 'International' and 'China'? Just confirming this is the desired pattern - it's consistent throughout, which is good.

baseUrl: "https://api.z.ai/api/coding/paas/v4",
isChina: false,
},
international: { name: "International Standard", baseUrl: "https://api.z.ai/api/paas/v4", isChina: false },
china_coding: { name: "China Coding Plan", baseUrl: "https://open.bigmodel.cn/api/coding/paas/v4", isChina: true },
china: { name: "China Standard", baseUrl: "https://open.bigmodel.cn/api/paas/v4", isChina: true },
china: { name: "China", baseUrl: "https://open.bigmodel.cn/api/coding/paas/v4", isChina: true },
} satisfies Record<ZaiApiLine, { name: string; baseUrl: string; isChina: boolean }>
4 changes: 2 additions & 2 deletions src/api/providers/__tests__/zai.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ describe("ZAiHandler", () => {
new ZAiHandler({ zaiApiKey: "test-zai-api-key", zaiApiLine: "international" })
expect(OpenAI).toHaveBeenCalledWith(
expect.objectContaining({
baseURL: "https://api.z.ai/api/paas/v4",
baseURL: "https://api.z.ai/api/coding/paas/v4",
}),
)
})
Expand Down Expand Up @@ -81,7 +81,7 @@ describe("ZAiHandler", () => {
it("should use the correct China Z AI base URL", () => {
new ZAiHandler({ zaiApiKey: "test-zai-api-key", zaiApiLine: "china" })
expect(OpenAI).toHaveBeenCalledWith(
expect.objectContaining({ baseURL: "https://open.bigmodel.cn/api/paas/v4" }),
expect.objectContaining({ baseURL: "https://open.bigmodel.cn/api/coding/paas/v4" }),
)
})

Expand Down
4 changes: 2 additions & 2 deletions src/api/providers/zai.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,14 @@ import { BaseOpenAiCompatibleProvider } from "./base-openai-compatible-provider"

export class ZAiHandler extends BaseOpenAiCompatibleProvider<InternationalZAiModelId | MainlandZAiModelId> {
constructor(options: ApiHandlerOptions) {
const isChina = zaiApiLineConfigs[options.zaiApiLine ?? "international_coding"].isChina
const isChina = zaiApiLineConfigs[options.zaiApiLine ?? "international"].isChina
Copy link
Contributor

@roomote roomote bot Sep 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this removes existing enum values ('international_coding' and 'china_coding'), users with existing configurations using these values might encounter runtime issues. Could we consider adding a migration handler here?

Suggested change
const isChina = zaiApiLineConfigs[options.zaiApiLine ?? "international"].isChina
const isChina = zaiApiLineConfigs[options.zaiApiLine ?? "international"].isChina ||
// Handle legacy values for backward compatibility
(options.zaiApiLine === "china_coding" ||
(options.zaiApiLine as any) === "international_coding" && false);

This would gracefully handle legacy configurations.

const models = isChina ? mainlandZAiModels : internationalZAiModels
const defaultModelId = isChina ? mainlandZAiDefaultModelId : internationalZAiDefaultModelId

super({
...options,
providerName: "Z AI",
baseURL: zaiApiLineConfigs[options.zaiApiLine ?? "international_coding"].baseUrl,
baseURL: zaiApiLineConfigs[options.zaiApiLine ?? "international"].baseUrl,
apiKey: options.zaiApiKey ?? "not-provided",
defaultProviderModelId: defaultModelId,
providerModels: models,
Expand Down
12 changes: 10 additions & 2 deletions webview-ui/src/components/settings/ModelInfoView.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,12 +102,20 @@ export const ModelInfoView = ({

const infoItems = shouldShowTierPricingTable ? baseInfoItems : [...baseInfoItems, ...priceInfoItems]

// Localize provider-specific model descriptions when available
const zaiDescKey = `settings:providers.zaiModels.${selectedModelId}.description`
const zaiLocalizedDesc = apiProvider === "zai" ? t(zaiDescKey) : undefined
const descriptionToUse =
apiProvider === "zai" && zaiLocalizedDesc && zaiLocalizedDesc !== zaiDescKey
? zaiLocalizedDesc
: modelInfo?.description

return (
<>
{modelInfo?.description && (
{descriptionToUse && (
<ModelDescriptionMarkdown
key="description"
markdown={modelInfo.description}
markdown={descriptionToUse}
isExpanded={isDescriptionExpanded}
setIsExpanded={setIsDescriptionExpanded}
/>
Expand Down
7 changes: 4 additions & 3 deletions webview-ui/src/components/settings/providers/ZAi.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,15 @@ export const ZAi = ({ apiConfiguration, setApiConfigurationField }: ZAiProps) =>
<div>
<label className="block font-medium mb-1">{t("settings:providers.zaiEntrypoint")}</label>
<VSCodeDropdown
value={apiConfiguration.zaiApiLine || zaiApiLineSchema.enum.international_coding}
value={apiConfiguration.zaiApiLine || zaiApiLineSchema.enum.international}
Copy link
Contributor

@roomote roomote bot Sep 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good job updating the default value here. This ensures the UI properly reflects the new simplified options.

onChange={handleInputChange("zaiApiLine")}
className={cn("w-full")}>
{zaiApiLineSchema.options.map((zaiApiLine) => {
const config = zaiApiLineConfigs[zaiApiLine]
const label = t(`settings:providers.zaiEntrypointOptions.${zaiApiLine}`)
return (
<VSCodeOption key={zaiApiLine} value={zaiApiLine} className="p-2">
{config.name} ({config.baseUrl})
{label} ({config.baseUrl})
</VSCodeOption>
)
})}
Expand All @@ -64,7 +65,7 @@ export const ZAi = ({ apiConfiguration, setApiConfigurationField }: ZAiProps) =>
{!apiConfiguration?.zaiApiKey && (
<VSCodeButtonLink
href={
zaiApiLineConfigs[apiConfiguration.zaiApiLine ?? "international_coding"].isChina
zaiApiLineConfigs[apiConfiguration.zaiApiLine ?? "international"].isChina
? "https://open.bigmodel.cn/console/overview"
: "https://z.ai/manage-apikey/apikey-list"
}
Expand Down
12 changes: 12 additions & 0 deletions webview-ui/src/i18n/locales/en/settings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -294,6 +294,18 @@
"getZaiApiKey": "Get Z AI API Key",
"zaiEntrypoint": "Z AI Entrypoint",
"zaiEntrypointDescription": "Please select the appropriate API entrypoint based on your location. If you are in China, choose open.bigmodel.cn. Otherwise, choose api.z.ai.",
"zaiEntrypointOptions": {
"international": "International",
"china": "China"
},
"zaiModels": {
"glm-4.5": {
Copy link
Member

@daniel-lxs daniel-lxs Sep 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Currently we save these descriptions in the types package and they are all in English, unless we want to change all of them I think it makes sense to keep them like that

"description": "GLM-4.5 is Zhipu's latest featured model. Its comprehensive capabilities in reasoning, coding, and agent reach the state-of-the-art (SOTA) level among open-source models, with a context length of up to 128k."
},
"glm-4.5-air": {
"description": "GLM-4.5-Air is the lightweight version of GLM-4.5. It balances performance and cost-effectiveness, and can flexibly switch to hybrid thinking models."
}
},
"geminiApiKey": "Gemini API Key",
"getGroqApiKey": "Get Groq API Key",
"groqApiKey": "Groq API Key",
Expand Down
12 changes: 12 additions & 0 deletions webview-ui/src/i18n/locales/zh-CN/settings.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 12 additions & 0 deletions webview-ui/src/i18n/locales/zh-TW/settings.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading