mirror of
https://github.com/danny-avila/LibreChat.git
synced 2025-12-22 03:10:15 +01:00
update: "documents" folder to "docs" (#391)
* Rename .github/PULL_REQUEST_TEMPLATE/PULL-REQUEST.md to .github/pull_request_template.md fix: Pull Request Template Location * documents -> docs * Update windows_install.md Fix: Docker hyperlink * Update linux_install.md Fix: Layout (step 6) * Rename docs/contributions/code_of_conduct.md to CODE_OF_CONDUCT.md fix: Code of Conduct location according to GitHub's Guide * Update CODE_OF_CONDUCT.md Update: Contact info * Update README.md Update: Code of Conduct hyperlink in TOC * Update CODE_OF_CONDUCT.md Update: Link to ReadMe * Update CONTRIBUTORS.md update: add new name to the list * Update and rename docs/contributions/contributor_guidelines.md to CONTRIBUTING.md fix: change location according to GitHub's standards * Delete CONTRIBUTORS.md delete: contributor.md from root (already present in readme) * Update SECURITY.md * Update CONTRIBUTING.md Update discord link to point to rules * Update README.md Update discord link to point to rules * Update README.md fix: ToC
This commit is contained in:
parent
f40a2f8ee8
commit
d437e4b8cd
26 changed files with 34 additions and 57 deletions
69
docs/features/plugins/google_search.md
Normal file
69
docs/features/plugins/google_search.md
Normal file
|
|
@ -0,0 +1,69 @@
|
|||
# AI-Assisted Google Search
|
||||
This bot supports searching google 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:
|
||||
```env
|
||||
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
|
||||
|
||||
<!-- You can limit the max price that is charged for a single search request by setting `MAX_SEARCH_PRICE` in your `.env` file. -->
|
||||
|
||||
|
||||
## 1\. Go to the [Programmable Search Engine docs](https://developers.google.com/custom-search/docs/tutorial/creatingcse) 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):
|
||||
|
||||

|
||||
|
||||
|
||||
## 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:
|
||||
|
||||

|
||||
|
||||
|
||||
## 4\. Create a new search engine
|
||||
|
||||
|
||||
Fill in a name, select to "Search the entire web" and hit "Create":
|
||||
|
||||

|
||||
|
||||
|
||||
## 5\. Copy your Search engine ID to your .env file
|
||||
|
||||
|
||||

|
||||
|
||||
|
||||
## 6\. Go to [custom-search docs](https://developers.google.com/custom-search/v1/introduction) to get a Google search API key
|
||||
|
||||
|
||||
Click "Get a Key":
|
||||
|
||||

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

|
||||
|
||||
|
||||
## 9\. Copy your Google search API key to your .env file
|
||||
|
||||
|
||||

|
||||
##
|
||||
|
||||
## [Go Back to ReadMe](../../../README.md)
|
||||
Loading…
Add table
Add a link
Reference in a new issue