atxcowboy / megasearch

A plugin for Oobabooga TextUI that allows you to search multiple search engines. Initially we're using Google API or DuckDuckGo.
GNU General Public License v3.0
16 stars 1 forks source link

Megasearch

Megasearch for Oobabooga TextUI is an extension that allows a user to search multiple search engines and include the output in the context. Initially we're using Google API and Searx.

As this is an Open Source project your PRs are very much welcome!

Installation

  1. To install the plugin, copy the megasearch folder to the text-generation-webui/extensions folder in your Ooobabooga installation.
  2. In Oobabooga enter your python environment. If you have used the 1-click installer you need to click on

cmd_linux or cmd_macos or cmd_windows,

then in the new console window navigate to text-generation-webui/extensions and run

pip install -r requirements.txt

  1. Open script.py and fill in your Google API Key as well as the CSE_ID. Follow the instructions at https://developers.google.com/custom-search/v1/overview?hl=en

If you plan on using Searx, you need to substitute http://localhost:80 with the URL of your self hosted Searx installation. Panomity GmbH can set up a self hosted Searx installation for you.

  1. Launch Oobabooga with the flag --extension megasearch as per their documentation at https://github.com/oobabooga/text-generation-webui/blob/main/docs/Extensions.md
  2. In the Oobabooga interface check "Enable Search" and choose your Search Engine. Initially you have a choice between Google and DuckDuckGo. Please note that Google Search is a paid API that relies on credentials whereas DuckDuckGo does not even need an API key and is free to use. prompt1