LibreChat/docs/features/plugins/google_search.md
Fuegovic bce4f41fae
🪪mkdocs: social cards (#1428)
* mkdocs plugins: add plugin for social cards and plugin that allow to exclude a folder

* docs: fix hyperlinks

* mkdocs: social cards (descriptions) for 'contributions' and 'deployment' guides

* mkdocs: social cards (descriptions) for all 'index.md'

* mkdocs: social cards (descriptions) for 'features' and 'plugins'

* mkdocs: social cards (descriptions) for 'general_info'

* mkdocs: social cards (descriptions) for 'configuration'

* mkdocs: social cards (descriptions) for 'installation'

* mkdocs: minor fixes

* update librechat.svg

* update how_to_contribute.md

add reference to the official GitHub documentation
2023-12-28 17:10:06 -05:00

2.7 KiB

title description weight
🔎 Google Search How to set up and use the Google Search Plugin, which allows you to query Google with GPT's help. -7

Google Search Plugin

Through the plugins endpoint, you can use google search for answers to your questions with assistance from GPT! To get started, you need to get a Google Custom Search API key, and a Google Custom Search Engine ID. You can then define these as follows in your .env file:

GOOGLE_API_KEY="...."  
GOOGLE_CSE_ID="...."  

You first need to create a programmable search engine and get the search engine ID: https://developers.google.com/custom-search/docs/tutorial/creatingcse

Then you can get the API key, click the "Get a key" button on this page: https://developers.google.com/custom-search/v1/introduction

1. Go to the Programmable Search Engine docs to get a Search engine ID

2. Click on "Control Panel" under "Defining a Programmable Engine in Control Panel"

Click to sign in(make a Google acct if you do not have one):

google_search-1

3. Register yourself a new account/Login to the Control Panel

After logging in, you will be redirected to the Control Panel to create a new search engine:

google_search-2

4. Create a new search engine

Fill in a name, select to "Search the entire web" and hit "Create":

google_search-3

5. Copy your Search engine ID to your .env file

google_search-4

6. Go to custom-search docs to get a Google search API key

7. Click "Get a Key":

google_search-5

8. Name your project and agree to the Terms of Service

google_search-6

9. Copy your Google search API key to your .env file

google_search-7