Skip to content

Update API key instructions in README #2

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
jrday wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update API key instructions in README #2

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
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,17 +23,17 @@ and Spring Shell or a simple [Javelit](https://javelit.io/) UI for interaction.

### Prerequisites

**API Key**: Set at least one LLM provider API key as an environment variable:
**API Key**: This project requires API keys for both the LLM and embeddings models:

```bash
# For OpenAI (GPT models)
# Required: OpenAI API key is required for the default embeddings model, and optionally to use OpenAI LLMs (default configuration)
export OPENAI_API_KEY=sk-...

# For Anthropic (Claude models)
# Optional: Anthropic API key for Claude LLMs
export ANTHROPIC_API_KEY=sk-ant-...
```

The model configured in `application.yml` determines which key is required. The default configuration uses OpenAI.
The model configured in `application.yml` determines which key is required. The default configuration uses OpenAI. If you choose to configure the project to use an Anthropic LLM, you will still need to set an OPENAI_API_KEY to use the default-embedding-model in this project.

**Java**: Java 21+ is required.

Expand Down