-
-
Notifications
You must be signed in to change notification settings - Fork 2.4k
feat(llm): add configurable web search engines (Tavily, SearXNG) #9342
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.
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
Draft
Kureii
wants to merge
2
commits into
TriliumNext:main
Choose a base branch
from
Kureii:feat/llm-web-search-engines
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,130 @@ | ||
| /** | ||
| * Custom web search tools for LLM chat. | ||
| * Provides Tavily and SearXNG search as alternatives to provider-built-in web search. | ||
| */ | ||
|
|
||
| import { tool } from "ai"; | ||
| import type { ToolSet } from "ai"; | ||
| import { z } from "zod"; | ||
|
|
||
| import log from "../log.js"; | ||
|
|
||
| const MAX_RESULTS = 5; | ||
| const DEFAULT_TIMEOUT_MS = 15_000; | ||
|
|
||
| /** Create an AbortSignal that times out after the given milliseconds. */ | ||
| function timeoutSignal(ms: number): AbortSignal { | ||
| return AbortSignal.timeout(ms); | ||
| } | ||
|
|
||
| interface TavilyResult { | ||
| title: string; | ||
| url: string; | ||
| content: string; | ||
| } | ||
|
|
||
| interface SearxngResult { | ||
| title: string; | ||
| url: string; | ||
| content: string; | ||
| } | ||
|
|
||
| /** | ||
| * Add a Tavily web search tool to the tool set. | ||
| * Tavily is an AI-optimized search API that returns clean, relevant results. | ||
| * Free tier: 1000 queries/month at https://tavily.com | ||
| */ | ||
| export function addTavilySearchTool(tools: ToolSet, apiKey: string, timeoutMs: number = DEFAULT_TIMEOUT_MS): void { | ||
| tools.web_search = tool({ | ||
| description: "Search the web for current information using Tavily. Use this when the user asks about recent events, real-time data, or anything requiring up-to-date web information.", | ||
| inputSchema: z.object({ | ||
| query: z.string().describe("The search query") | ||
| }), | ||
| execute: async ({ query }) => { | ||
| try { | ||
| const response = await fetch("https://api.tavily.com/search", { | ||
| method: "POST", | ||
| headers: { "Content-Type": "application/json" }, | ||
| body: JSON.stringify({ | ||
| api_key: apiKey, | ||
| query, | ||
| max_results: MAX_RESULTS, | ||
| include_answer: true | ||
| }), | ||
| signal: timeoutSignal(timeoutMs) | ||
| }); | ||
|
|
||
| if (!response.ok) { | ||
| const errorText = await response.text(); | ||
| log.error(`Tavily search failed: ${response.status} ${errorText}`); | ||
| return { error: `Search failed: ${response.status}` }; | ||
| } | ||
|
|
||
| const data = await response.json() as { answer?: string; results: TavilyResult[] }; | ||
|
|
||
| return { | ||
| answer: data.answer || undefined, | ||
| results: data.results.map((r: TavilyResult) => ({ | ||
| title: r.title, | ||
| url: r.url, | ||
| snippet: r.content | ||
| })) | ||
| }; | ||
| } catch (e) { | ||
| log.error(`Tavily search error: ${e}`); | ||
| return { error: `Search failed: ${e instanceof Error ? e.message : String(e)}` }; | ||
| } | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * Add a SearXNG web search tool to the tool set. | ||
| * SearXNG is a self-hosted metasearch engine that aggregates results from multiple sources. | ||
| * No API key required — just a running SearXNG instance URL. | ||
| */ | ||
| export function addSearxngSearchTool(tools: ToolSet, instanceUrl: string, timeoutMs: number = DEFAULT_TIMEOUT_MS): void { | ||
| // Normalize the URL (remove trailing slash) | ||
| const baseUrl = instanceUrl.replace(/\/+$/, ""); | ||
|
|
||
| tools.web_search = tool({ | ||
| description: "Search the web for current information using SearXNG. Use this when the user asks about recent events, real-time data, or anything requiring up-to-date web information.", | ||
| inputSchema: z.object({ | ||
| query: z.string().describe("The search query") | ||
| }), | ||
| execute: async ({ query }) => { | ||
| try { | ||
| const params = new URLSearchParams({ | ||
| q: query, | ||
| format: "json", | ||
| categories: "general", | ||
| language: "auto" | ||
| }); | ||
|
|
||
| const response = await fetch(`${baseUrl}/search?${params}`, { | ||
| headers: { "Accept": "application/json" }, | ||
| signal: timeoutSignal(timeoutMs) | ||
| }); | ||
|
|
||
| if (!response.ok) { | ||
| const errorText = await response.text(); | ||
| log.error(`SearXNG search failed: ${response.status} ${errorText}`); | ||
| return { error: `Search failed: ${response.status}` }; | ||
| } | ||
|
|
||
| const data = await response.json() as { results: SearxngResult[] }; | ||
|
|
||
| return { | ||
| results: (data.results || []).slice(0, MAX_RESULTS).map((r: SearxngResult) => ({ | ||
| title: r.title, | ||
| url: r.url, | ||
| snippet: r.content | ||
| })) | ||
| }; | ||
| } catch (e) { | ||
| log.error(`SearXNG search error: ${e}`); | ||
| return { error: `Search failed: ${e instanceof Error ? e.message : String(e)}` }; | ||
| } | ||
| } | ||
| }); | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.