2025-04-28 10:53:59 +00:00
|
|
|
# LobeChat Google Custom Search Plugin
|
2024-12-18 22:28:36 +00:00
|
|
|
|
2025-04-28 10:53:59 +00:00
|
|
|
A LobeChat search plugin that uses the [Google Custom Search API](https://developers.google.com/custom-search).
|
2024-12-18 22:28:36 +00:00
|
|
|
|
2025-04-28 10:53:59 +00:00
|
|
|
## Setup Steps
|
2025-04-28 10:38:21 +00:00
|
|
|
|
2025-04-28 10:53:59 +00:00
|
|
|
1. Create a Google Custom Search Engine
|
|
|
|
- Visit [Google Programmable Search Engine](https://programmablesearch.google.com/create)
|
|
|
|
- Create a custom search engine
|
|
|
|
- Get your search engine ID (cx parameter)
|
2025-04-28 10:38:21 +00:00
|
|
|
|
2025-04-28 10:53:59 +00:00
|
|
|
2. Get Google API Key
|
|
|
|
- Visit [Google Cloud Console](https://console.cloud.google.com/)
|
|
|
|
- Create a project
|
|
|
|
- Enable "Custom Search API"
|
|
|
|
- Create an API key (key parameter)
|
2025-04-28 10:38:21 +00:00
|
|
|
|
2025-04-28 10:53:59 +00:00
|
|
|
3. Configure the Plugin in LobeChat
|
|
|
|
- Add this plugin to LobeChat
|
|
|
|
- Provide your API key and search engine ID in the configuration page
|
|
|
|
- These credentials will be automatically added to each request as secure parameters
|
2025-04-28 10:38:21 +00:00
|
|
|
|
2025-04-28 10:53:59 +00:00
|
|
|
## Authentication Method
|
2025-04-28 10:38:21 +00:00
|
|
|
|
2025-04-28 10:53:59 +00:00
|
|
|
This plugin uses the following two secure parameters:
|
|
|
|
- `key`: Your Google API key
|
|
|
|
- `cx`: Your custom search engine ID
|
2025-04-28 10:38:21 +00:00
|
|
|
|
2025-04-28 10:53:59 +00:00
|
|
|
These two parameters are added as query parameters to the API request.
|
2025-04-28 10:38:21 +00:00
|
|
|
|
2025-04-28 10:53:59 +00:00
|
|
|
## Limitations
|
2025-04-28 10:38:21 +00:00
|
|
|
|
2025-04-28 10:53:59 +00:00
|
|
|
- Google Custom Search API free version is limited to 100 queries per day
|
|
|
|
- Paid version provides more quota
|
2025-04-28 10:38:21 +00:00
|
|
|
|
2025-04-28 10:53:59 +00:00
|
|
|
## Privacy
|
2025-04-28 10:38:21 +00:00
|
|
|
|
2025-04-28 10:53:59 +00:00
|
|
|
- Your search queries will be sent to Google
|
|
|
|
- This plugin does not collect or store your personal data
|
2025-04-28 10:38:21 +00:00
|
|
|
|
2025-04-28 10:53:59 +00:00
|
|
|
`(Not affiliated with any of the above entities)`
|