phonny40rowle/rag-search

选用指南

AI 根据 README 整理 · 2026/11/5 22:47:08

使用方式

通过FastAPI服务提供REST API接口，使用HTTP请求调用。

查看 README 依据

# rag-search A self-hosted RAG search API.  ## quick start 1. put .env file under root dir, set values like below: ```ini SERPER_API_KEY= OPENAI_BASE_URL= OPENAI_API_KEY= OPENAI_MODEL=gpt-3.5-turbo OPENAI_EMBED_MODEL=text-embedding-ada-002 ZILLIZ_URI= ZILLIZ_TOKEN= ZILLIZ_DIM=1536 ZILLIZ_COLLECTION= AUTH_API_KEY= ``` 2. install dependencies ```shell pip install -r requirements.txt ``` 3. start FastAPI server ```shell uvicorn main:app --reload --port 8069 ``` 4. make api request ```txt

@baseUri=http://127.0.0.1:8069 @apiKey=xxx ### ping GET {{baseUri}}/ ### rag search POST {{baseUri}}/rag-search Content-Type: application/json Authorization: Bearer {{apiKey}} { "query": "retrieval augmented generation", "search_n": 10, "search_provider": "google", "is_reranking": true, "is_detail": true, "detail_min_score": 0.7, "detail_top_k": 3, "is_filter": true, "filter_min_score": 0.8, "filter_top_k": 6 } ```

部署要求

需要配置SERPER_API_KEY、OpenAI API密钥、Zilliz数据库凭据及认证密钥。

查看 README 依据

# rag-search A self-hosted RAG search API.  ## quick start 1. put .env file under root dir, set values like below: ```ini SERPER_API_KEY= OPENAI_BASE_URL= OPENAI_API_KEY= OPENAI_MODEL=gpt-3.5-turbo OPENAI_EMBED_MODEL=text-embedding-ada-002 ZILLIZ_URI= ZILLIZ_TOKEN= ZILLIZ_DIM=1536 ZILLIZ_COLLECTION= AUTH_API_KEY= ``` 2. install dependencies ```shell pip install -r requirements.txt ``` 3. start FastAPI server ```shell uvicorn main:app --reload --port 8069 ``` 4. make api request ```txt