Merge pull request #3625 from SillyTavern/gemini-search Add backend-provided websearch connectors for OpenRouter and Gemini

bcb2096020a23731b16fa9201527aa50b83ab484

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

Signed

Parents: 50f1e3f0f25ce859bee2a34c269591f2627465fc fa699956e674eab6611b6205f1f7f5a5240bd666

public/index.html+12 -1 Viewed

                                             </span>
                                         </div>
                                     </div>
-                                    <div class="range-block" data-source="openai,cohere,mistralai,custom,claude,openrouter,groq,deepseek">
+                                    <div class="range-block" data-source="makersuite,openrouter">
+                                        <label for="openai_enable_web_search" class="checkbox_label flexWrap widthFreeExpand">
+                                            <input id="openai_enable_web_search" type="checkbox" />
+                                            <span data-i18n="Enable web search">Enable web search</span>
+                                        </label>
+                                        <div class="flexBasis100p toggle-description justifyLeft">
+                                            <span>
+                                                Use search capabilities provided by the backend.
+                                            </span>
+                                        </div>
+                                    </div>
+                                    <div class="range-block" data-source="openai,cohere,mistralai,custom,claude,openrouter,groq,deepseek,makersuite">
                                         <label for="openai_function_calling" class="checkbox_label flexWrap widthFreeExpand">
                                             <input id="openai_function_calling" type="checkbox" />
                                             <span data-i18n="Enable function calling">Enable function calling</span>

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

     function_calling: ['#openai_function_calling', 'function_calling', true],
     show_thoughts: ['#openai_show_thoughts', 'show_thoughts', true],
     reasoning_effort: ['#openai_reasoning_effort', 'reasoning_effort', false],
+    enable_web_search: ['#openai_enable_web_search', 'enable_web_search', true],
     seed: ['#seed_openai', 'seed', false],
     n: ['#n_openai', 'n', false],
     bypass_status_check: ['#openai_bypass_status_check', 'bypass_status_check', true],

     custom_prompt_post_processing: custom_prompt_post_processing_types.NONE,
     show_thoughts: true,
     reasoning_effort: 'medium',
+    enable_web_search: false,
     seed: -1,
     n: 1,
 };

     custom_prompt_post_processing: custom_prompt_post_processing_types.NONE,
     show_thoughts: true,
     reasoning_effort: 'medium',
+    enable_web_search: false,
     seed: -1,
     n: 1,
 };

         'group_names': getGroupNames(),
         'include_reasoning': Boolean(oai_settings.show_thoughts),
         'reasoning_effort': String(oai_settings.reasoning_effort),
+        'enable_web_search': Boolean(oai_settings.enable_web_search),
     };
     if (!canMultiSwipe && ToolManager.canPerformToolCalls(type)) {

     oai_settings.bypass_status_check = settings.bypass_status_check ?? default_settings.bypass_status_check;
     oai_settings.show_thoughts = settings.show_thoughts ?? default_settings.show_thoughts;
     oai_settings.reasoning_effort = settings.reasoning_effort ?? default_settings.reasoning_effort;
+    oai_settings.enable_web_search = settings.enable_web_search ?? default_settings.enable_web_search;
     oai_settings.seed = settings.seed ?? default_settings.seed;
     oai_settings.n = settings.n ?? default_settings.n;

     $('#seed_openai').val(oai_settings.seed);
     $('#n_openai').val(oai_settings.n);
     $('#openai_show_thoughts').prop('checked', oai_settings.show_thoughts);
+    $('#openai_enable_web_search').prop('checked', oai_settings.enable_web_search);
     $('#openai_reasoning_effort').val(oai_settings.reasoning_effort);
     $(`#openai_reasoning_effort option[value="${oai_settings.reasoning_effort}"]`).prop('selected', true);

         function_calling: settings.function_calling,
         show_thoughts: settings.show_thoughts,
         reasoning_effort: settings.reasoning_effort,
+        enable_web_search: settings.enable_web_search,
         seed: settings.seed,
         n: settings.n,
     };

         saveSettingsDebounced();
     });
+    $('#openai_enable_web_search').on('input', function () {
+        oai_settings.enable_web_search = !!$(this).prop('checked');
+        saveSettingsDebounced();
+    });
     if (!CSS.supports('field-sizing', 'content')) {
         $(document).on('input', '#openai_settings .autoSetHeight', function () {
             resetScrollHeight($(this));

public/scripts/sse-stream.js+5 -0 Viewed

     else if (Array.isArray(json.candidates)) {
         for (let i = 0; i < json.candidates.length; i++) {
             const isNotPrimary = json.candidates?.[0]?.index > 0;
+            const hasToolCalls = json?.candidates?.[0]?.content?.parts?.some(p => p?.functionCall);
             if (isNotPrimary || json.candidates.length === 0) {
                 return null;
+            }
+            if (hasToolCalls) {
+                yield { data: json, chunk: '' };
+                return;
+            }
             if (typeof json.candidates[0].content === 'object' && Array.isArray(json.candidates[i].content.parts)) {
                 for (let j = 0; j < json.candidates[i].content.parts.length; j++) {
                     if (typeof json.candidates[i].content.parts[j].text === 'string') {

public/scripts/tool-calling.js+33 -0 Viewed

+                }
+            }
+        }
+        if (Array.isArray(parsed?.candidates)) {
+            for (let choiceIndex = 0; choiceIndex < parsed.candidates.length; choiceIndex++) {
+                const candidate = parsed.candidates[choiceIndex];
+                if (Array.isArray(candidate?.content?.parts)) {
+                    for (let toolCallIndex = 0; toolCallIndex < candidate.content.parts.length; toolCallIndex++) {
+                        const part = candidate.content.parts[toolCallIndex];
+                        if (part.functionCall) {
+                            if (!Array.isArray(toolCalls[choiceIndex])) {
+                                toolCalls[choiceIndex] = [];
+                            }
+                            if (toolCalls[choiceIndex][toolCallIndex] === undefined) {
+                                toolCalls[choiceIndex][toolCallIndex] = {};
+                            }
+                            const targetToolCall = toolCalls[choiceIndex][toolCallIndex];
+                            ToolManager.#applyToolCallDelta(targetToolCall, part.functionCall);
+                        }
+                    }
+                }
+            }
+        }
+    }
     /**

             chat_completion_sources.GROQ,
             chat_completion_sources.COHERE,
             chat_completion_sources.DEEPSEEK,
+            chat_completion_sources.MAKERSUITE,
         ];
         return supportedSources.includes(oai_settings.chat_completion_source);
+    }

      * @returns {any[]} Tool calls from the response data
      */
     static #getToolCallsFromData(data) {
+        const getRandomId = () => Math.random().toString(36).substring(2);
         const isClaudeToolCall = c => Array.isArray(c) ? c.filter(x => x).every(isClaudeToolCall) : c?.input && c?.name && c?.id;
+        const isGoogleToolCall = c => Array.isArray(c) ? c.filter(x => x).every(isGoogleToolCall) : c?.name && c?.args;
         const convertClaudeToolCall = c => ({ id: c.id, function: { name: c.name, arguments: c.input } });
+        const convertGoogleToolCall = (c) => ({ id: getRandomId(), function: { name: c.name, arguments: c.args } });
         // Parsed tool calls from streaming data
         if (Array.isArray(data) && data.length > 0 && Array.isArray(data[0])) {

@@ -594,6 +618,10 @@ export class ToolManager {
594	return data[0].filter(x => x).map(convertClaudeToolCall);	618	return data[0].filter(x => x).map(convertClaudeToolCall);
595	}	619	}
596		620
		621	if (isGoogleToolCall(data[0])) {
		622	return data[0].filter(x => x).map(convertGoogleToolCall);
		623	}
		624
597	if (typeof data[0]?.[0]?.tool_calls === 'object') {	625	if (typeof data[0]?.[0]?.tool_calls === 'object') {
598	return Array.isArray(data[0]?.[0]?.tool_calls) ? data[0][0].tool_calls : [data[0][0].tool_calls];	626	return Array.isArray(data[0]?.[0]?.tool_calls) ? data[0][0].tool_calls : [data[0][0].tool_calls];
599	}	627	}

             return data[0];
+        }
+        // Google AI Studio tool calls
+        if (Array.isArray(data?.responseContent?.parts)) {
+            return data.responseContent.parts.filter(p => p.functionCall).map(p => convertGoogleToolCall(p.functionCall));
+        }
         // Parsed tool calls from non-streaming data
         if (Array.isArray(data?.choices)) {
             // Find a choice with 0-index

src/endpoints/backends/chat-completions.js+44 -1 Viewed

+}
 /**
+ * Gets OpenRouter plugins based on the request.
+ * @param {import('express').Request} request
+ * @returns {any[]} OpenRouter plugins
+ */
+function getOpenRouterPlugins(request) {
+    const plugins = [];
+    if (request.body.enable_web_search) {
+        plugins.push({ 'id': 'web' });
+    }
+    return plugins;
+}
+/**
  * Sends a request to Claude API.
  * @param {express.Request} request Express request
  * @param {express.Response} response Express response

     const model = String(request.body.model);
     const stream = Boolean(request.body.stream);
+    const enableWebSearch = Boolean(request.body.enable_web_search);
     const isThinking = model.includes('thinking');
     const generationConfig = {

             model.startsWith('gemini-exp')
         ) && request.body.use_makersuite_sysprompt;
+        const tools = [];
         const prompt = convertGooglePrompt(request.body.messages, model, should_use_system_prompt, getPromptNames(request));
         let safetySettings = GEMINI_SAFETY;

+        }
         // Most of the other models allow for setting the threshold of filters, except for HARM_CATEGORY_CIVIC_INTEGRITY, to OFF.
+        if (enableWebSearch) {
+            const searchTool = model.includes('1.5') || model.includes('1.0')
+                ? ({ google_search_retrieval: {} })
+                : ({ google_search: {} });
+            tools.push(searchTool);
+        }
+        if (Array.isArray(request.body.tools) && request.body.tools.length > 0) {
+            const functionDeclarations = [];
+            for (const tool of request.body.tools) {
+                if (tool.type === 'function') {
+                    if (tool.function.parameters?.$schema) {
+                        delete tool.function.parameters.$schema;
+                    }
+                    functionDeclarations.push(tool.function);
+                }
+            }
+            tools.push({ function_declarations: functionDeclarations });
+        }
         let body = {
             contents: prompt.contents,
             safetySettings: safetySettings,

@@ -371,6 +408,10 @@ async function sendMakerSuiteRequest(request, response) {
371	body.systemInstruction = prompt.system_instruction;	408	body.systemInstruction = prompt.system_instruction;
372	}	409	}
373		410
		411	if (tools.length) {
		412	body.tools = tools;
		413	}
		414
374	return body;	415	return body;
375	}	416	}
376		417

+            }
             const responseContent = candidates[0].content ?? candidates[0].output;
+            const functionCall = (candidates?.[0]?.content?.parts ?? []).some(part => part.functionCall);
             console.warn('Google AI Studio response:', responseContent);
             const responseText = typeof responseContent === 'string' ? responseContent : responseContent?.parts?.filter(part => !part.thought)?.map(part => part.text)?.join('\n\n');
-            if (!responseText) {
+            if (!responseText && !functionCall) {
                 let message = 'Google AI Studio Candidate text empty';
                 console.warn(message, generateResponseJson);
                 return response.send({ error: { message } });

         headers = { ...OPENROUTER_HEADERS };
         bodyParams = {
             'transforms': getOpenRouterTransforms(request),
+            'plugins': getOpenRouterPlugins(request),
             'include_reasoning': Boolean(request.body.include_reasoning),
         };

src/prompt-converters.js+38 -4 Viewed

 import crypto from 'node:crypto';
-import { getConfigValue } from './util.js';
+import { getConfigValue, tryParse } from './util.js';
 const PROMPT_PLACEHOLDER = getConfigValue('promptPlaceholder', 'Let\'s get started.');

+    }
     const system_instruction = { parts: { text: sys_prompt.trim() } };
+    const toolNameMap = {};
     const contents = [];
     messages.forEach((message, index) => {
         // fix the roles
-        if (message.role === 'system') {
+        if (message.role === 'system' || message.role === 'tool') {
             message.role = 'user';
         } else if (message.role === 'assistant') {
             message.role = 'model';

         // Convert the content to an array of parts
         if (!Array.isArray(message.content)) {
-            message.content = [{ type: 'text', text: String(message.content ?? '') }];
+            const content = (() => {
+                const hasToolCalls = Array.isArray(message.tool_calls) && message.tool_calls.length > 0;
+                const hasToolCallId = typeof message.tool_call_id === 'string' && message.tool_call_id.length > 0;
+                if (hasToolCalls) {
+                    return { type: 'tool_calls', tool_calls: message.tool_calls };
+                }
+                if (hasToolCallId) {
+                    return { type: 'tool_call_id', tool_call_id: message.tool_call_id, content: String(message.content ?? '') };
+                }
+                return { type: 'text', text: String(message.content ?? '') };
+            })();
+            message.content = [content];
+        }
         // similar story as claude

         message.content.forEach((part) => {
             if (part.type === 'text') {
                 parts.push({ text: part.text });
+            } else if (part.type === 'tool_call_id') {
+                const name = toolNameMap[part.tool_call_id] ?? 'unknown';
+                parts.push({
+                    functionResponse: {
+                        name: name,
+                        response: { name: name, content: part.content },
+                    },
+                });
+            } else if (part.type === 'tool_calls') {
+                part.tool_calls.forEach((toolCall) => {
+                    parts.push({
+                        functionCall: {
+                            name: toolCall.function.name,
+                            args: tryParse(toolCall.function.arguments) ?? toolCall.function.arguments,
+                        },
+                    });
+                    toolNameMap[toolCall.id] = toolCall.function.name;
+                });
             } else if (part.type === 'image_url' && isMultimodal) {
                 const mimeType = part.image_url.url.split(';')[0].split(':')[1];
                 const base64Data = part.image_url.url.split(',')[1];

@@ -473,7 +507,7 @@ export function convertGooglePrompt(messages, model, useSysPrompt, names) {
473	if (part.text) {	507	if (part.text) {
474	contents[contents.length - 1].parts[0].text += '\n\n' + part.text;	508	contents[contents.length - 1].parts[0].text += '\n\n' + part.text;
475	}	509	}
476	if (part.inlineData) {	510	if (part.inlineData \|\| part.functionCall \|\| part.functionResponse) {
477	contents[contents.length - 1].parts.push(part);	511	contents[contents.length - 1].parts.push(part);
478	}	512	}
479	});	513	});