Skip to content

Commit cfe1165

Browse files
committed
docs: add EMBEDDINGS_TYPE valid options to README and .env.example
Signed-off-by: YASHBHIWANIA <yashbhiwania772@gmail.com>
1 parent 5c7f3b5 commit cfe1165

File tree

2 files changed

+3
-0
lines changed

2 files changed

+3
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ git clone https://github.com/The-OpenROAD-Project/ORAssistant.git
6363
```
6464

6565
**Step 2**: Copy the `.env.example` file, and update your `.env` file with the appropriate API keys.
66+
> **Note:** When configuring `EMBEDDINGS_TYPE`, valid options are `HF`, `GOOGLE_GENAI`, or `GOOGLE_VERTEXAI`. If using `HF`, no API key is needed but startup is slower. If using `GOOGLE_GENAI`, ensure `GOOGLE_API_KEY` is set.
6667
6768
Modify the Docker `HEALTHCHECK_` variables based on the hardware requirements.
6869
If you have a resource-constrained PC, try increasing `HEALTHCHECK_START_PERIOD` to a value large
@@ -99,6 +100,7 @@ uv sync
99100
```
100101

101102
**Step 2**: Copy the `.env.example` file, and update your `.env` file with the appropriate API keys.
103+
> **Note:** When configuring `EMBEDDINGS_TYPE`, valid options are `HF`, `GOOGLE_GENAI`, or `GOOGLE_VERTEXAI`. If using `HF`, no API key is needed but startup is slower. If using `GOOGLE_GENAI`, ensure `GOOGLE_API_KEY` is set.
102104
103105
```bash
104106
cd backend

backend/.env.example

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ GOOGLE_GEMINI=2.0_flash
2222

2323
LLM_TEMP=1
2424

25+
# Choose embeddings type (options: HF, GOOGLE_GENAI, GOOGLE_VERTEXAI)
2526
EMBEDDINGS_TYPE=GOOGLE_GENAI
2627
GOOGLE_EMBEDDINGS=gemini-embedding-001
2728
HF_EMBEDDINGS=thenlper/gte-large

0 commit comments

Comments
 (0)