Skip to content

docs: add EMBEDDINGS_TYPE valid options to README and .env.example #249

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
YASHBHIWANIA wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: add EMBEDDINGS_TYPE valid options to README and .env.example #249

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ git clone https://github.com/The-OpenROAD-Project/ORAssistant.git
```

**Step 2**: Copy the `.env.example` file, and update your `.env` file with the appropriate API keys.
> **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.

Modify the Docker `HEALTHCHECK_` variables based on the hardware requirements.
If you have a resource-constrained PC, try increasing `HEALTHCHECK_START_PERIOD` to a value large
Expand Down Expand Up @@ -99,6 +100,7 @@ uv sync
```

**Step 2**: Copy the `.env.example` file, and update your `.env` file with the appropriate API keys.
> **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.

```bash
cd backend
Expand Down
1 change: 1 addition & 0 deletions backend/.env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ GOOGLE_GEMINI=2.0_flash

LLM_TEMP=1

# Choose embeddings type (options: HF, GOOGLE_GENAI, GOOGLE_VERTEXAI)
EMBEDDINGS_TYPE=GOOGLE_GENAI
GOOGLE_EMBEDDINGS=gemini-embedding-001
HF_EMBEDDINGS=thenlper/gte-large
Expand Down