support moonshot api

fatwang2 · Apr 20, 2024 · 86b1270 · 86b1270
1 parent 09d4071
commit 86b1270
Show file tree

Hide file tree

Showing 5 changed files with 78 additions and 123 deletions.
diff --git a/README-EN.md b/README-EN.md
@@ -7,6 +7,7 @@
 <a href="https://www.buymeacoffee.com/fatwang2" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;" ></a>
 
 # Version Updates
+- V0.2.2, 20240420, support Moonshot API
 - V0.2.1, 20240310, supports Google, Bing, Duckduckgo, Search1API for news-type searches; supports adjusting the number of search results via the MAX_RESULTS environment variable; supports adjusting the number of in-depth searches desired via the CRAWL_RESULTS environment variable.
 - V0.2.0，20240310，Optimized openai.js, cloudflare worker version, really faster this time!
 - V0.1.9, 20240318, optimized the handling of streams in openai.js for faster speed, recommend updating; fixed the audio issue in the server deployment version; added a sponsored button on Github.
@@ -16,13 +17,11 @@
 - V0.1.5, 20240205, supports news search, making it more convenient to quickly browse news
 - V0.1.4, 20240120, Supports one-click deployment with Zeabur, very convenient, highly recommended!
 - V0.1.3, 20240120, Supports local deployment, can be deployed on your own server
-- V0.1.2, 20240115, Fixes streaming output issues in non-search scenarios for the cloudflare worker version
-- V0.1.1, 20240114, Supports one-click deployment with Vercel, currently suitable for those who like tinkering
 
 For more historical updates, please see [Version History](https://github.com/fatwang2/search2ai/releases)
 
-# Product Introduction
-- search2ai, so that your LLM API support networking, search, news, web page summarization, has supported OpenAI, Gemini, the big model will be based on your input to determine whether the network, not every time the network search, do not need to install any plug-ins, do not need to replace the key, directly in your commonly used OpenAI/Gemini three-way client replacement of custom You can directly replace the customized address in your usual OpenAI/Gemini three-way client, and also support self-deployment, which will not affect the use of other functions, such as drawing, voice, etc.
+# S2A
+Help your LLM API support networking, search, news, web page summarization, has supported OpenAI, Gemini, Moonshot, the big model will be based on your input to determine whether the network, not every time the network search, do not need to install any plug-ins, do not need to replace the key, directly in your commonly used OpenAI/Gemini three-way client replacement of custom You can directly replace the customized address in your usual OpenAI/Gemini three-way client, and also support self-deployment, which will not affect the use of other functions, such as drawing, voice, etc.
 
 <table>
     <tr>
@@ -35,68 +34,39 @@ For more historical updates, please see [Version History](https://github.com/fat
     </tr>
 </table>
 
+# Features
+| Model | Features | Stream                                                                                                                                                               | Deployments                                                                                                              |
+| -------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
+| `OpenAI`     | search, news, crawler      | stream, unstream| Zeabur, Local deployment, Cloudflare Worker, Vercel|
+| `Gemini`     | search      | stream, unstream| Cloudflare Worker|
+| `Moonshot`     | search, news, crawler      | unstream| Zeabur, Local deployment, Cloudflare Worker, Vercel|
 
-# How to Use
-**Direct use: Replace the custom domain in the client with the following address**
+# Usage
+**Replace the custom domain in any client with the following address**
 
-OpenAI
-```
-https://api.search2ai.online
-```
-Gemini
-```
-https://geminiapi.search2ai.online
-```
-As shown in the picture
 <table>
     <tr>
-        <td><img src="pictures/Opencat2.png" alt="Effect Example"></td>
         <td><img src="pictures/NextChat.png" alt="Effect Example"></td>
     </tr>
 </table>
 
-Demo site experience address:
-- [OpenAI](https://search2ai.online/demo), follow the instructions to use your key, replace the custom domain
-- [Gemini](https://search2ai.online/gemini)
+# Deployment
+**Zeabur**
 
-**One-Click Deployment with Zeabur (Highly Recommended)**
-
-Click the button for one-click deployment, default duckduckgo search, can be switched on your own
+Click the button for one-click deployment, switched on your own environment variables
 
 [![Deploy on Zeabur](https://zeabur.com/button.svg)](https://zeabur.com/templates/A4HGYF?referralCode=fatwang2)
 
 To keep the project updated, it is recommended to fork this repository first, then deploy your branch through Zeabur
 
 [![Deployed on Zeabur](https://zeabur.com/deployed-on-zeabur-dark.svg)](https://zeabur.com?referralCode=fatwang2&utm_source=fatwang2&utm_campaign=oss)
 
-Environment variables
-- SEARCH_SERVICE: temporarily supports search1api, google, bing, serpapi, serper, duckduckgo, required
-- APIBASE: if you are using OpenAI three-way proxy, you can fill in here, note that you do not need to add v1, non-required!
-- MAX_RESULTS：the results of search
-- CRAWL_RESULTS：the reults of search you want to crawl
-- SEARCH1API_KEY: such as the selection of search1api required, I build their own search services, 0.99 U.S. dollars / 1000 times per month, the application address https://search21api.com
-- BING_KEY: Required if choosing bing search, please search for tutorials, application address https://search2ai.online/bing
-- GOOGLE_CX: Required if choosing Google search, Search engine ID, please search for tutorials, application address https://search2ai.online/googlecx
-- GOOGLE_KEY: Required if choosing Google search, API key, application address https://search2ai.online/googlekey
-- SERPAPI_KEY: Required if choosing serpapi, free 100 times/month, registration address https://search2ai.online/serpapi
-- SERPER_KEY: Required if choosing serper, free 2500 times for 6 months, note variable name is different from above, registration address https://search2ai.online/serper
-
 **Local Deployment**
 1. Clone the repository locally
 ```
 git clone https://github.com/fatwang2/search2ai
 ```
 2. Copy .env.template as .env, configure environment variables
-- SEARCH_SERVICE: temporarily supports search1api, google, bing, serpapi, serper, duckduckgo, required
-- APIBASE: if you are using OpenAI three-way proxy, you can fill in here, note that you do not need to add v1, non-required!
-- MAX_RESULTS：the results of search
-- CRAWL_RESULTS：the reults of search you want to crawl
-- SEARCH1API_KEY: such as the selection of search1api required, I build their own search services, 0.99 U.S. dollars / 1000 times per month, the application address https://search21api.com
-- BING_KEY: Required if choosing bing search, please search for tutorials, application address https://search2ai.online/bing
-- GOOGLE_CX: Required if choosing Google search, Search engine ID, please search for tutorials, application address https://search2ai.online/googlecx
-- GOOGLE_KEY: Required if choosing Google search, API key, application address https://search2ai.online/googlekey
-- SERPAPI_KEY: Required if choosing serpapi, free 100 times/month, registration address https://search2ai.online/serpapi
-- SERPER_KEY: Required if choosing serper, free 2500 times for 6 months, note variable name is different from above, registration address https://search2ai.online/serper
 
 3. Enter the api directory, run the program, and display the log in real-time
 ```
@@ -108,26 +78,16 @@ cd api && nohup node index.js > output.log 2>&1 & tail -f output.log
 http://localhost:3014/v1/chat/completions
 ```
 
-**Deployment with cloudflare worker**
-1. Copy the code of [openai.js](https://search2ai.online/cloudflare), or [gemini.js](https://search2ai.online/geminicf),no modifications needed! Deploy in cloudflare's worker, after going online, the worker's address can be used as your interface call's custom domain address, note the concatenation, worker address only represents the part before v1
+**Cloudflare worker**
+1. Copy the code of [search2openai.js](search2openai.js), or [search2gemini.js](search2gemini.js),no modifications needed! Deploy in cloudflare's worker, after going online, the worker's address can be used as your interface call's custom domain address, note the concatenation, worker address only represents the part before v1
 
 2. Configure variables in the worker（only openai）
 ![Effect Example](pictures/worker.png)
-- SEARCH_SERVICE: temporarily supports search1api, google, bing, serpapi, serper, duckduckgo, required
-- APIBASE: if you are using OpenAI three-way proxy, you can fill in here, note that you do not need to add v1, non-required!
-- MAX_RESULTS：the results of search
-- CRAWL_RESULTS：the reults of search you want to crawl
-- SEARCH1API_KEY: such as the selection of search1api required, I build their own search services, 0.99 U.S. dollars / 1000 times per month, the application address https://search21api.com
-- BING_KEY: Required if choosing bing search, please search for tutorials, application address https://search2ai.online/bing
-- GOOGLE_CX: Required if choosing Google search, Search engine ID, please search for tutorials, application address https://search2ai.online/googlecx
-- GOOGLE_KEY: Required if choosing Google search, API key, application address https://search2ai.online/googlekey
-- SERPAPI_KEY: Required if choosing serpapi, free 100 times/month, registration address https://search2ai.online/serpapi
-- SERPER_KEY: Required if choosing serper, free 2500 times for 6 months, note variable name is different from above, registration address https://search2ai.online/serper
 
 3. Configure triggers - custom domain in the worker, direct access to the worker's address in China might have issues, need to replace with custom domain
 ![Alt text](pictures/域名.png)
 
-**Deployment with Vercel**
+**Vercel**
 
 Special note: Vercel project does not support streaming output and has a 10s response limit, actual user experience is poor, released mainly for experts to pull request
 
@@ -137,6 +97,22 @@ One-click deployment
 
 To ensure updates, you can also first fork this project and then deploy it on Vercel yourself
 
+# Environment Variables
+This project provides some additional configuration options, which can be set through environment variables:
+
+| Environment Variable | Required | Description                                                                                                                                                               | Example                                                                                                              |
+| -------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
+| `SEARCH_SERVICE`     | Yes      | Your search service. The key of the service you choose needs to be configured. Supports search1api, google, bing, serpapi, serper, duckduckgo. | `search1api, google, bing, serpapi, serper, duckduckgo` |
+| `APIBASE`     | No      | OpenAI third-party proxy address. If using Moonshot, fill in `https://api.moonshot.cn`. | `https://api.openai.com` |
+| `MAX_RESULTS`     | No      | Number of search results. | `10` |
+| `CRAWL_RESULTS`     | No      | The number of deep searches (retrieve the main text of the webpage after searching). Currently only supports search1api, deep search will be slow. | `1` |
+| `SEARCH1API_KEY`     | Conditional      | Required if search1api is selected. My own fast and cheap search service. Apply at https://search21api.com. | `xxx` |
+| `BING_KEY`     | Conditional      | Required if Bing search is selected. Please search for the tutorial yourself. Apply at https://search2ai.online/bing. | `xxx` |
+| `GOOGLE_CX`     | Conditional      | Required if Google search is selected. Search engine ID. Please search for the tutorial yourself. Apply at https://search2ai.online/googlecx. | `xxx` |
+| `GOOGLE_KEY`     | Conditional      | Required if Google search is selected. API key. Apply at https://search2ai.online/googlekey. | `xxx` |
+| `SERPAPI_KEY`     | Conditional      | Required if serpapi is selected. Free 100 times/month. Register at https://search2ai.online/serpapi. | `xxx` |
+| `SERPER_KEY`     | Conditional      | Required if serper is selected. Free 2500 times for 6 months. Register at https://search2ai.online/serper. | `xxx` |
+
 # Risk statement
 To ensure the persistence of this project, certain interface requests will be forwarded via [search1api](https://search.search2ai.one). Please be assured that this forwarding service does not save any private data.