Skip to content

Commit e80c13f

Browse files
committed
added setup doc for open ai integration
1 parent 8c75adf commit e80c13f

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

SETUP.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -264,6 +264,34 @@ You can customize any variables in these files before or after bootstrapping.
264264
- **`npm ci` errors**:
265265
- Check your `package-lock.json` is in sync with `package.json`.
266266

267+
---
268+
269+
## 🤖 Open AI integration
270+
271+
### Prerequisites
272+
- open ai api key [create new key from here](https://platform.openai.com/api-keys)
273+
- LLM model name you'd like to use e.g [gpt-4.1-2025-04-14](https://platform.openai.com/docs/models/gpt-4.1)
274+
- embedding model name you'd like to use e.g. [text-embedding-3-large](https://platform.openai.com/docs/guides/embeddings#embedding-models)
275+
276+
### Update environment keys at `./apps/backend/.env`
277+
For example if you want to use gpt4.1 with text embedding 3 large apppend below at the end of `.env` file
278+
```env
279+
LLM_API_KEY="YOUR_OPEN_AI_API_KEY"
280+
EMBEDDING_API_KEY="YOUR_OPEN_AI_API_KEY"
281+
LLM_PROVIDER="openai"
282+
EMBEDDING_PROVIDER="openai"
283+
LL_MODEL="gpt-4.1-2025-04-14"
284+
EMBEDDING_MODEL="text-embedding-3-large"
285+
```
286+
287+
### re-run the server
288+
```bash
289+
make run-dev
290+
```
291+
292+
Now you don't need to run ollama locally, it will communicate with open ai's api server.
293+
294+
267295
---
268296

269297
## 🖋️ Frontend

0 commit comments

Comments
 (0)