Z.AI: Add endpoint selection (#4789) * Z.AI: Add endpoint selection Closes #4778 * Add i18n support for Z.AI endpoint options * Update message for captioning ext. * Remove unused imports * Add api-url autoconnect guard

a66801213831b507e774324c894f18aadec2acbc

Cohee <18619528+Cohee1207@users.noreply.github.com>

Signed

Parents: c31d92c9092310197258e70885f4e3df6ea98ac4

public/index.html+5 -0 Viewed

                             <div data-for="api_key_zai" class="neutral_warning" data-i18n="For privacy reasons, your API key will be hidden after you click 'Connect'.">
                                 For privacy reasons, your API key will be hidden after you click 'Connect'.
                             </div>
+                            <h4 data-i18n="Z.AI Endpoint">Z.AI Endpoint</h4>
+                            <select id="zai_endpoint">
+                                <option value="common" data-i18n="Common API">Common API</option>
+                                <option value="coding" data-i18n="Coding API">Coding API</option>
+                            </select>
                             <h4 data-i18n="Z.AI Model">Z.AI Model</h4>
                             <select id="model_zai_select">
                                 <option value="glm-4.6">glm-4.6</option>

public/scripts/extensions/caption/settings.html+3 -0 Viewed

                         <option data-type="custom" value="custom_current" data-i18n="currently_selected">[Currently selected]</option>
                     </select>
                 </div>
+                <div data-type="zai">
+                    <b>Will use Common API. Coding API is not supported!</b>
+                </div>
                 <div data-type="ollama">
                     <div>
                         The model must be downloaded first! Do it with the <code>ollama pull</code> command or <a href="#" id="caption_ollama_pull">click here</a>.

public/scripts/openai.js+16 -0 Viewed

     max: 'max',
 };
+export const ZAI_ENDPOINT = {
+    COMMON: 'common',
+    CODING: 'coding',
+};
 const sensitiveFields = [
     'reverse_proxy',
     'proxy_password',

     google_model: ['#model_google_select', 'google_model', false, true],
     vertexai_model: ['#model_vertexai_select', 'vertexai_model', false, true],
     zai_model: ['#model_zai_select', 'zai_model', false, true],
+    zai_endpoint: ['#zai_endpoint', 'zai_endpoint', false, true],
     openai_max_context: ['#openai_max_context', 'openai_max_context', false, false],
     openai_max_tokens: ['#openai_max_tokens', 'openai_max_tokens', false, false],
     wrap_in_quotes: ['#wrap_in_quotes', 'wrap_in_quotes', true, false],

     moonshot_model: 'kimi-latest',
     fireworks_model: 'accounts/fireworks/models/kimi-k2-instruct',
     zai_model: 'glm-4.6',
+    zai_endpoint: ZAI_ENDPOINT.COMMON,
     azure_base_url: '',
     azure_deployment_name: '',
     azure_api_version: '2024-02-15-preview',

     if (isZai) {
         generate_data['top_p'] = generate_data.top_p || 0.01;
         generate_data['stop'] = getCustomStoppingStrings(1);
+        generate_data['zai_endpoint'] = oai_settings.zai_endpoint || ZAI_ENDPOINT.COMMON;
         delete generate_data.presence_penalty;
         delete generate_data.frequency_penalty;
+    }

     oai_settings.moonshot_model = settings.moonshot_model ?? default_settings.moonshot_model;
     oai_settings.fireworks_model = settings.fireworks_model ?? default_settings.fireworks_model;
     oai_settings.zai_model = settings.zai_model ?? default_settings.zai_model;
+    oai_settings.zai_endpoint = settings.zai_endpoint ?? default_settings.zai_endpoint;
     oai_settings.custom_model = settings.custom_model ?? default_settings.custom_model;
     oai_settings.custom_url = settings.custom_url ?? default_settings.custom_url;
     oai_settings.custom_include_body = settings.custom_include_body ?? default_settings.custom_include_body;

     $(`#model_moonshot_select option[value="${oai_settings.moonshot_model}"`).prop('selected', true);
     $('#model_zai_select').val(oai_settings.zai_model);
     $(`#model_zai_select option[value="${oai_settings.zai_model}"`).prop('selected', true);
+    $('#zai_endpoint').val(oai_settings.zai_endpoint);
+    $(`#zai_endpoint option[value="${oai_settings.zai_endpoint}"`).prop('selected', true);
     $('#custom_model_id').val(oai_settings.custom_model);
     $('#custom_api_url_text').val(oai_settings.custom_url);
     $('#azure_base_url').val(oai_settings.azure_base_url);

         fireworks_model: settings.fireworks_model,
         cometapi_model: settings.cometapi_model,
         zai_model: settings.zai_model,
+        zai_endpoint: settings.zai_endpoint,
         custom_model: settings.custom_model,
         custom_url: settings.custom_url,
         custom_include_body: settings.custom_include_body,

         oai_settings.vertexai_express_project_id = String($(this).val());
         saveSettingsDebounced();
     });
+    $('#zai_endpoint').on('input', function () {
+        oai_settings.zai_endpoint = String($(this).val());
+        saveSettingsDebounced();
+    });
     $('#vertexai_service_account_json').on('input', onVertexAIServiceAccountJsonChange);
     $('#vertexai_validate_service_account').on('click', onVertexAIValidateServiceAccount);
     $('#vertexai_clear_service_account').on('click', onVertexAIClearServiceAccount);

public/scripts/slash-commands.js+29 -2 Viewed

 import { getContext, saveMetadataDebounced } from './extensions.js';
 import { getRegexedString, regex_placement } from './extensions/regex/engine.js';
 import { findGroupMemberId, groups, is_group_generating, openGroupById, resetSelectedGroup, saveGroupChat, selected_group, getGroupMembers } from './group-chats.js';
-import { chat_completion_sources, oai_settings, promptManager } from './openai.js';
+import { chat_completion_sources, oai_settings, promptManager, ZAI_ENDPOINT } from './openai.js';
 import { user_avatar } from './personas.js';
 import { addEphemeralStoppingString, chat_styles, context_presets, flushEphemeralStoppingStrings, power_user } from './power-user.js';
 import { SERVER_INPUTS, textgen_types, textgenerationwebui_settings } from './textgen-settings.js';

                 typeList: [ARGUMENT_TYPE.STRING],
                 enumList: [
                     new SlashCommandEnumValue('custom', 'custom OpenAI-compatible', enumTypes.getBasedOnIndex(UNIQUE_APIS.findIndex(x => x === 'openai')), 'O'),
+                    new SlashCommandEnumValue('zai', 'Z.AI', enumTypes.getBasedOnIndex(UNIQUE_APIS.findIndex(x => x === 'zai')), 'Z'),
                     new SlashCommandEnumValue('kobold', 'KoboldAI Classic', enumTypes.getBasedOnIndex(UNIQUE_APIS.findIndex(x => x === 'kobold')), 'K'),
                     ...Object.values(textgen_types).map(api => new SlashCommandEnumValue(api, null, enumTypes.getBasedOnIndex(UNIQUE_APIS.findIndex(x => x === 'textgenerationwebui')), 'T')),
                 ],

                 ${t`If a manual API is provided to <b>set</b> the URL, make sure to set <code>connect=false</code>, as auto-connect only works for the currently selected API, or consider switching to it with <code>/api</code> first.`}
             </div>
             <div>
-                ${t`This slash command works for most of the Text Completion sources, KoboldAI Classic, and also Custom OpenAI compatible for the Chat Completion sources. If unsure which APIs are supported, check the auto-completion of the optional <code>api</code> argument of this command.`}
+                ${t`This slash command works for most of the Text Completion sources, KoboldAI Classic, and also Custom OpenAI compatible and Z.AI for the Chat Completion sources. If unsure which APIs are supported, check the auto-completion of the optional <code>api</code> argument of this command.`}
             </div>
         `,
     }));

         return url;
+    }
+    const isCurrentlyZAI = main_api === 'openai' && oai_settings.chat_completion_source === chat_completion_sources.ZAI;
+    if (api === chat_completion_sources.ZAI || (!api && isCurrentlyZAI)) {
+        if (!url) {
+            return oai_settings.zai_endpoint || ZAI_ENDPOINT.COMMON;
+        }
+        const permittedValues = Object.values(ZAI_ENDPOINT);
+        if (!permittedValues.includes(url)) {
+            !isQuiet && toastr.warning(t`Valid options are: ${permittedValues.join(', ')}`, t`ZAI endpoint '${url}' is not a valid option.`);
+            return '';
+        }
+        if (!isCurrentlyZAI && autoConnect) {
+            toastr.warning(t`Z.AI is not the currently selected API, so we cannot do an auto-connect. Consider switching to it via /api beforehand.`);
+            return '';
+        }
+        $('#zai_endpoint').val(url).trigger('input');
+        if (autoConnect) {
+            $('#api_button_openai').trigger('click');
+        }
+        return oai_settings.zai_endpoint || ZAI_ENDPOINT.COMMON;
+    }
     // Special handling for Kobold Classic API
     const isCurrentlyKoboldClassic = main_api === 'kobold';
     if (api === 'kobold' || (!api && isCurrentlyKoboldClassic)) {

src/constants.js+5 -0 Viewed

     'm4a',
     'aiff',
 ];
+export const ZAI_ENDPOINT = {
+    COMMON: 'common',
+    CODING: 'coding',
+};

src/endpoints/backends/chat-completions.js+4 -2 Viewed

     OPENAI_REASONING_EFFORT_MODELS,
     OPENROUTER_HEADERS,
     VERTEX_SAFETY,
+    ZAI_ENDPOINT,
 } from '../../constants.js';
 import {
     forwardFetchResponse,

 const API_MOONSHOT = 'https://api.moonshot.ai/v1';
 const API_FIREWORKS = 'https://api.fireworks.ai/inference/v1';
 const API_COMETAPI = 'https://api.cometapi.com/v1';
-const API_ZAI = 'https://api.z.ai/api/paas/v4';
+const API_ZAI_COMMON = 'https://api.z.ai/api/paas/v4';
+const API_ZAI_CODING = 'https://api.z.ai/api/coding/paas/v4';
 const API_SILICONFLOW = 'https://api.siliconflow.com/v1';
 /**

         };
         throw new Error('This provider is temporarily disabled.');
     } else if (request.body.chat_completion_source === CHAT_COMPLETION_SOURCES.ZAI) {
-        apiUrl = API_ZAI;
+        apiUrl = request.body.zai_endpoint === ZAI_ENDPOINT.CODING ? API_ZAI_CODING : API_ZAI_COMMON;
         apiKey = readSecret(request.user.directories, SECRET_KEYS.ZAI);
         headers = {
             'Accept-Language': 'en-US,en',