Skip to content

Commit c2bcb9a

Browse files
authored
Enhance documentation for LLM model setup (#1014)
- Split config into sections per provider - Add info about Azure AI - Add Deepseek config - Fix formatting Signed-off-by: Christian Köberl <[email protected]>
1 parent 4072054 commit c2bcb9a

File tree

1 file changed

+20
-6
lines changed
  • embabel-agent-docs/src/main/asciidoc/getting-started/installing

1 file changed

+20
-6
lines changed

embabel-agent-docs/src/main/asciidoc/getting-started/installing/page.adoc

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -177,15 +177,29 @@ dependencies {
177177

178178
Before running your application, you'll need to set up your environment with API keys for the LLM providers you plan to use.
179179

180-
Required:
181-
- `OPENAI_API_KEY`: For OpenAI models (GPT-4, GPT-5, etc.)
182-
183-
Optional but recommended:
184-
- `ANTHROPIC_API_KEY`: For Anthropic models (Claude 3.x, etc.)
185-
186180
Example `.env` file:
187181
----
188182
OPENAI_API_KEY=your_openai_api_key_here
189183
ANTHROPIC_API_KEY=your_anthropic_api_key_here
190184
----
191185

186+
===== OpenAI Compatible (GPT-4, GPT-5, etc.)
187+
188+
* Required:
189+
- `OPENAI_API_KEY`: API key for OpenAI or compatible services (e.g., Azure OpenAI, etc.)
190+
* Optional:
191+
- `OPENAI_BASE_URL`: base URL of the OpenAI deployment (for Azure AI use `https://{resource-name}.openai.azure.com/openai`)
192+
- `OPENAI_COMPLETIONS_PATH`: custom path for completions endpoint (default: `/v1/completions`)
193+
- `OPENAI_EMBEDDINGS_PATH`: custom path for embeddings endpoint (default: `/v1/embeddings`)
194+
195+
===== Anthropic (Claude 3.x, etc.)
196+
197+
* Required:
198+
- `ANTHROPIC_API_KEY`: API key for Anthropic services
199+
200+
===== DeepSeek
201+
202+
* Required:
203+
- `DEEPSEEK_API_KEY`: API key for DeepSeek services
204+
* Optional:
205+
- `DEEPSEEK_BASE_URL`: base URL for DeepSeek API (default: `https://api.deepseek.com`)

0 commit comments

Comments
 (0)