From 7d2641989b7cc779195c4f842f1b5a22f2a92cd7 Mon Sep 17 00:00:00 2001
From: 90houlaoheshang <907333918@qq.com>
Date: Tue, 5 Nov 2024 16:14:45 +0800
Subject: [PATCH] =?UTF-8?q?docs(README):=20=E6=B7=BB=E5=8A=A0=E7=8E=AF?=
 =?UTF-8?q?=E5=A2=83=E5=8F=98=E9=87=8F=E9=85=8D=E7=BD=AE=E8=AF=B4=E6=98=8E?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

- 在 README.md 文件中补充了环境变量配置步骤
- 新增 OPENAI_BASE_URL、OPENAI_API_KEY、LLM_MODEL 和 EMBEDDING_MODEL 环境变量的说明
- 为使用 OpenAI API 和自定义模型提供了更详细的配置指南
---
 README.md | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/README.md b/README.md
index 6602f1d3..3e3a1761 100644
--- a/README.md
+++ b/README.md
@@ -498,6 +498,10 @@ pip install fastapi uvicorn pydantic
 2. Set up your environment variables:
 ```bash
 export RAG_DIR="your_index_directory"  # Optional: Defaults to "index_default"
+export OPENAI_BASE_URL="Your OpenAI API base URL"  # Optional: Defaults to "https://api.openai.com/v1"
+export OPENAI_API_KEY="Your OpenAI API key"  # Required
+export LLM_MODEL="Your LLM model" # Optional: Defaults to "gpt-4o-mini" 
+export EMBEDDING_MODEL="Your embedding model" # Optional: Defaults to "text-embedding-3-large" 
 ```
 
 3. Run the API server: