Websearch using Bing API (#1420)

* feat: bing search enabled

* lint

* feat: bing url hardcoded

* lint

---------

Co-authored-by: Nathan Sarrazin <[email protected]>

.env

@@ -27,6 +27,7 @@ SERPSTACK_API_KEY=#your serpstack api key here
 SEARCHAPI_KEY=#your searchapi api key here
 USE_LOCAL_WEBSEARCH=#set to true to parse google results yourself, overrides other API keys
 SEARXNG_QUERY_URL=# where '<query>' will be replaced with query keywords see https://docs.searxng.org/dev/search_api.html eg https://searxng.yourdomain.com/search?q=<query>&engines=duckduckgo,google&format=json
+BING_SUBSCRIPTION_KEY=#your key
 PLAYWRIGHT_ADBLOCKER=true
 
 WEBSEARCH_ALLOWLIST=`[]` # if it's defined, allow websites from only this list.

src/lib/server/websearch/search/endpoints.ts

@@ -7,10 +7,12 @@ import searchYouApi from "./endpoints/youApi";
 import searchWebLocal from "./endpoints/webLocal";
 import searchSearxng from "./endpoints/searxng";
 import searchSearchApi from "./endpoints/searchApi";
+import searchBing from "./endpoints/bing";
 
 export function getWebSearchProvider() {
 	if (env.YDC_API_KEY) return WebSearchProvider.YOU;
 	if (env.SEARXNG_QUERY_URL) return WebSearchProvider.SEARXNG;
+	if (env.BING_SUBSCRIPTION_KEY) return WebSearchProvider.BING;
 	return WebSearchProvider.GOOGLE;
 }
 
@@ -23,6 +25,7 @@ export async function searchWeb(query: string): Promise<WebSearchSource[]> {
 	if (env.SERPAPI_KEY) return searchSerpApi(query);
 	if (env.SERPSTACK_API_KEY) return searchSerpStack(query);
 	if (env.SEARCHAPI_KEY) return searchSearchApi(query);
+	if (env.BING_SUBSCRIPTION_KEY) return searchBing(query);
 	throw new Error(
 		"No configuration found for web search. Please set USE_LOCAL_WEBSEARCH, SEARXNG_QUERY_URL, SERPER_API_KEY, YDC_API_KEY, SERPSTACK_API_KEY, or SEARCHAPI_KEY in your environment variables."
 	);

src/lib/server/websearch/search/endpoints/bing.ts

@@ -0,0 +1,40 @@
+import type { WebSearchSource } from "$lib/types/WebSearch";
+import { env } from "$env/dynamic/private";
+
+export default async function search(query: string): Promise<WebSearchSource[]> {
+	// const params = {
+	//     q: query,
+	//     // You can add other parameters if needed, like 'count', 'offset', etc.
+	// };
+
+	const response = await fetch(
+		"https://api.bing.microsoft.com/v7.0/search" + "?q=" + encodeURIComponent(query),
+		{
+			method: "GET",
+			headers: {
+				"Ocp-Apim-Subscription-Key": env.BING_SUBSCRIPTION_KEY,
+				"Content-type": "application/json",
+			},
+		}
+	);
+
+	/* eslint-disable @typescript-eslint/no-explicit-any */
+	const data = (await response.json()) as Record<string, any>;
+
+	if (!response.ok) {
+		throw new Error(
+			data["message"] ?? `Bing API returned error code ${response.status} - ${response.statusText}`
+		);
+	}
+
+	console.log(data["webPages"]?.["value"]);
+
+	// Adapt the data structure from the Bing response to match the WebSearchSource type
+	const webPages = data["webPages"]?.["value"] ?? [];
+	return webPages.map((page: any) => ({
+		title: page.name,
+		link: page.url,
+		text: page.snippet,
+		displayLink: page.displayUrl,
+	}));
+}

src/lib/types/WebSearch.ts

@@ -45,4 +45,5 @@ export enum WebSearchProvider {
 	GOOGLE = "Google",
 	YOU = "You.com",
 	SEARXNG = "SearXNG",
+	BING = "Bing",
 }

src/routes/+layout.server.ts

@@ -155,7 +155,8 @@ export const load: LayoutServerLoad = async ({ locals, depends, request }) => {
 				env.SEARCHAPI_KEY ||
 				env.YDC_API_KEY ||
 				env.USE_LOCAL_WEBSEARCH ||
-				env.SEARXNG_QUERY_URL
+				env.SEARXNG_QUERY_URL ||
+				env.BING_SUBSCRIPTION_KEY
 			),
 			ethicsModalAccepted: !!settings?.ethicsModalAcceptedAt,
 			ethicsModalAcceptedAt: settings?.ethicsModalAcceptedAt ?? null,