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 1 commit
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
4 changes: 2 additions & 2 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,7 +33,7 @@ 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) => {
Expand Down Expand Up @@ -64,7 +64,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
Loading