🔍 Added Bing Search Plugin

.env.example

@@ -195,6 +195,10 @@ AZURE_AI_SEARCH_SEARCH_OPTION_SELECT=
 GOOGLE_API_KEY=
 GOOGLE_CSE_ID=
 
+# Bing Search
+#-----------------
+BING_SEARCH_API_KEY=
+
 # SerpAPI
 #-----------------
 SERPAPI_API_KEY=

api/app/clients/tools/manifest.json

@@ -30,6 +30,19 @@
       }
     ]
   },
+  {
+    "name": "Bing",
+    "pluginKey": "bing",
+    "description": "Use Bing Search to find information about the weather, news, sports, and more.",
+    "icon": "https://i.imgur.com/0Ly2bcl.png",
+    "authConfig": [
+      {
+        "authField": "BING_SEARCH_API_KEY",
+        "label": "Bing Search API Key",
+        "description": "This is your Bing Search API Key. For instructions on how to obtain this, see <a href='https://github.com/danny-avila/LibreChat/blob/main/docs/features/plugins/bing_search.md'>Our Docs</a>."
+      }
+    ]
+  },
   {
     "name": "Wolfram",
     "pluginKey": "wolfram",

api/app/clients/tools/structured/BingSearch.js

@@ -0,0 +1,94 @@
+const { z } = require('zod');
+const { Tool } = require('@langchain/core/tools');
+const { getEnvironmentVariable } = require('@langchain/core/utils/env');
+
+class BingSearch extends Tool {
+  static lc_name() {
+    return 'BingSearch';
+  }
+
+  constructor(fields = {}) {
+    super(fields);
+    this.envVarApiKey = 'BING_SEARCH_API_KEY';
+    this.apiKey = fields.apiKey ?? getEnvironmentVariable(this.envVarApiKey);
+
+    this.kwargs = fields?.kwargs ?? {};
+    this.name = 'bing';
+    this.description =
+      'A search engine optimized for comprehensive, accurate, and trusted results. Useful for when you need to answer questions about current events.';
+
+    this.schema = z.object({
+      query: z.string().min(1).describe('The search query string.'),
+      max_results: z
+        .number()
+        .min(1)
+        .max(50)
+        .optional()
+        .describe('The maximum number of search results to return. Defaults to 10.'),
+      market: z
+        .string()
+        .optional()
+        .describe('The market where the results come from. Defaults to "en-US".'),
+    });
+  }
+
+  async _call(input) {
+    const validationResult = this.schema.safeParse(input);
+    if (!validationResult.success) {
+      throw new Error(`Validation failed: ${JSON.stringify(validationResult.error.issues)}`);
+    }
+
+    const { query, max_results = 15 } = validationResult.data;
+
+    try {
+      const response = await fetch(
+        `https://api.bing.microsoft.com/v7.0/search?q=${encodeURIComponent(
+          query,
+        )}&count=${max_results}`,
+        {
+          method: 'GET',
+          headers: {
+            'Ocp-Apim-Subscription-Key': this.apiKey,
+            'Content-Type': 'application/json',
+          },
+        },
+      );
+
+      if (!response.ok) {
+        throw new Error(`Request failed with status ${response.status}: ${response.statusText}`);
+      }
+
+      const json = await response.json();
+
+      if (json.error) {
+        throw new Error(`Request failed: ${json.error.message}`);
+      }
+
+      const webPages = json.webPages?.value || [];
+      const rankingResponse = json.rankingResponse?.value || [];
+      const entities = json.entities?.value || [];
+      const news = json.news?.value || [];
+      const computation = json.computation?.value || [];
+      const timeZone = json.timeZone?.value || [];
+      const spellSuggestion = json.spellSuggestion?.value || '';
+      const translations = json.translations?.value || [];
+
+      const results = {
+        webPages,
+        entities,
+        news,
+        computation,
+        timeZone,
+        translations,
+        spellSuggestion,
+        rankingResponse,
+      };
+
+      return JSON.stringify(results);
+    } catch (error) {
+      throw new Error(`Request failed: ${error.message}`);
+    }
+  }
+}
+
+module.exports = BingSearch;

api/app/clients/tools/util/handleTools.js

@@ -9,7 +9,6 @@ const {
   // Basic Tools
   CodeBrew,
   AzureAISearch,
-  GoogleSearchAPI,
   WolframAlphaAPI,
   OpenAICreateImage,
   StableDiffusionAPI,
@@ -20,6 +19,8 @@ const {
   StructuredSD,
   StructuredACS,
   CodeSherpaTools,
+  BingSearch,
+  GoogleSearchAPI,
   TraversaalSearch,
   StructuredWolfram,
   TavilySearchResults,
@@ -160,6 +161,7 @@ const loadTools = async ({
   const toolConstructors = {
     tavily_search_results_json: TavilySearchResults,
     calculator: Calculator,
+    bing: BingSearch,
     google: GoogleSearchAPI,
     wolfram: functions ? StructuredWolfram : WolframAlphaAPI,
     'dall-e': OpenAICreateImage,

api/app/clients/tools/util/handleTools.test.js

@@ -27,6 +27,7 @@ const { validateTools, loadTools, loadToolWithAuth } = require('./handleTools');
 const {
   availableTools,
   OpenAICreateImage,
+  BingSearch,
   GoogleSearchAPI,
   StructuredSD,
   WolframAlphaAPI,
@@ -277,6 +278,23 @@ describe('Tool Handlers', () => {
       const Tool = await toolFunctions[testPluginKey]();
       expect(Tool).toBeInstanceOf(TestClass);
     });
+    it('should initialize an authenticated tool through Environment Variables for bing', async () => {
+      let testPluginKey = 'bing';
+      let TestClass = BingSearch;
+      const plugin = availableTools.find((tool) => tool.pluginKey === testPluginKey);
+      const authConfigs = plugin.authConfig;
+      for (const authConfig of authConfigs) {
+        process.env[authConfig.authField] = mockCredential;
+      }
+      toolFunctions = await loadTools({
+        user: fakeUser._id,
+        model: BaseChatModel,
+        tools: [testPluginKey],
+        returnMap: true,
+      });
+      const Tool = await toolFunctions[testPluginKey]();
+      expect(Tool).toBeInstanceOf(TestClass);
+    });
     it('returns an empty object when no tools are requested', async () => {
       toolFunctions = await loadTools({
         user: fakeUser._id,

docs/features/index.md

@@ -16,6 +16,7 @@ weight: 2
     * 🛠️ [Make Your Own](./plugins/make_your_own.md)
     * 🧑‍💼 [Official ChatGPT Plugins](./plugins/chatgpt_plugins_openapi.md)
     * 🔎 [Google Search](./plugins/google_search.md)
+    * 🔎 [Bing Search](./plugins/bing_search.md)
     * 🖌️ [Stable Diffusion](./plugins/stable_diffusion.md)
     * 🧠 [Wolfram|Alpha](./plugins/wolfram.md)
     * ⚡ [Azure AI Search](./plugins/azure_ai_search.md)

docs/features/plugins/bing_search.md

@@ -0,0 +1,59 @@
+---
+title: 🔎 Bing Search
+description: How to set up and use the Bing Search Plugin, which allows you to query Bing with GPT's help.
+weight: -7
+---
+
+# Bing Search Plugin
+Through the plugins endpoint, you can use Bing Search for answers to your questions with assistance from GPT! To get started, you need to get a Bing Search API key. You can then define these as follows in your `.env` file:  
+```env  
+BING_SEARCH_API_KEY="...."  
+```  
+
+## Create or login to your account on Azure Portal
+
+**1.** Visit [Azure Portal](https://azure.microsoft.com/en-us/) and click on `Get started` or `Try Azure for Free` to create an account and sign in.
+
+**2.** Choose pay per use or Azure Free with $200.
+
+![image](https://raw.githubusercontent.com/itzraiss/images/main/Captura%20de%20tela%202023-11-26%20151647.png?token=GHSAT0AAAAAACJ4TKEINPEOAV3LEPNPBDNCZLEKLAQ)
+
+## 1\. Access your control panel & Click on `Create a Resource`..
+
+![image](https://raw.githubusercontent.com/itzraiss/images/main/Captura%20de%20tela%202023-11-26%20151706.png?token=GHSAT0AAAAAACJ4TKEJDXD7E76YLZEV52Z4ZLEKLCQ)
+
+## 2\. Search for `Bing Search V7` in the bar and press enter.
+
+![image](https://raw.githubusercontent.com/itzraiss/images/main/Captura%20de%20tela%202024-04-03%20110147.png)
+
+## 3\. Now, click on `Create` e select `Bing Search V7`.
+
+## 4\. Configure the basics settings and click on 'Review + create'..
+
+**Pricing Tier (F1 is FREE)' Check out the prices of the service [here](https://www.microsoft.com/en-us/bing/apis/pricing).**
+
+![image](https://raw.githubusercontent.com/itzraiss/images/main/Captura%20de%20tela%202024-04-03%20110620.png)
+
+## 5\. Now, click on `Create`.
+
+![image](https://raw.githubusercontent.com/itzraiss/images/main/Captura%20de%20tela%202024-04-03%20111024.png)
+
+## 6\. You will be redirected to the resource dashboard. Click on `Keys & Endpoint` on the **left-hand** panel.
+
+![image](https://raw.githubusercontent.com/itzraiss/images/main/image.png)
+
+## 7\. Now, copy your key to your .env file
+
+![image](https://raw.githubusercontent.com/itzraiss/images/main/Captura%20de%20tela%202024-04-03%20111714.png)
+
+# Conclusion
+
+### Now, you will be able to conduct searches using Bing Search V7 in endpoint `Plugins & Assistants `. **Congratulations!** 🎉🎉
+
+**Plugins:**
+
+![image](https://raw.githubusercontent.com/itzraiss/images/main/Captura%20de%20tela%202024-04-03%20113022.png)
+
+**Assistants:**
+
+![image](https://raw.githubusercontent.com/itzraiss/images/main/Captura%20de%20tela%202024-04-03%20113029.png)

docs/features/plugins/index.md

@@ -9,6 +9,7 @@ weight: -9
 * 🛠️ [Make Your Own](./make_your_own.md)
 * 🧑‍💼 [Official ChatGPT Plugins](./chatgpt_plugins_openapi.md)
 * 🔎 [Google Search](./google_search.md)
+* 🔎 [Bing Search](./bing_search.md)
 * 🖌️ [Stable Diffusion](./stable_diffusion.md)
 * 🧠 [Wolfram|Alpha](./wolfram.md)
 * ⚡ [Azure AI Search](./azure_ai_search.md)

docs/features/plugins/introduction.md

@@ -50,6 +50,7 @@ Clicking on **"Show Agent Settings"** will allow you to modify parameters for th
 
 ### Plugins Setup Instructions
 - **[Google Search](./google_search.md)**
+- **[Bing Search](./bing_search.md)**
 - **[Stable Diffusion](./stable_diffusion.md)**
 - **[Wolfram](./wolfram.md)**
 - **DALL-E** - same setup as above, you just need an OpenAI key, and it's made distinct from your main API key to make Chats but it can be the same one

docs/install/configuration/dotenv.md

@@ -527,6 +527,13 @@ GOOGLE_API_KEY=
 GOOGLE_CSE_ID=
 ```
 
+#### Bing Search
+See detailed instructions here: [Bing Search](../../features/plugins/bing_search.md)
+
+```bash
+BING_SEARCH_API_KEY=
+```
+
 #### SerpAPI
 SerpApi is a real-time API to access Google search results (not as performant)