Skip to content

Commit a3b1124

Browse files
authored
docs: align Getting Started and examples with Google API key requirement (#56)
Signed-off-by: Aleksandr Suvorov <asuvorov@hensu.io>
1 parent dbe0cc4 commit a3b1124

7 files changed

Lines changed: 16 additions & 9 deletions

File tree

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,11 @@ working-dir/
5858

5959
### 3. Set an API key
6060

61+
The bundled example workflows use Google Gemini models. You can obtain a free
62+
`GOOGLE_API_KEY` from [Google AI Studio](https://aistudio.google.com/app/apikey).
63+
6164
```bash
62-
hensu credentials set ANTHROPIC_API_KEY # or OPENAI_API_KEY / GEMINI_API_KEY
65+
hensu credentials set GOOGLE_API_KEY
6366
```
6467

6568
### 4. Run a workflow
@@ -78,6 +81,9 @@ Pre-built binaries are available for **Linux x86_64**. On macOS or Windows,
7881
curl -L https://github.com/hensu-project/hensu/releases/download/server/v0.1.0-beta.1/hensu-server-linux-x86_64 \
7982
-o hensu-server-v0.1.0-beta.1 && chmod +x hensu-server-v0.1.0-beta.1
8083

84+
# The server needs provider API keys as environment variables
85+
export GOOGLE_API_KEY=<your-key>
86+
8187
# Start in in-memory mode (no database, no JWT)
8288
QUARKUS_PROFILE=inmem ./hensu-server-v0.1.0-beta.1
8389

@@ -102,8 +108,8 @@ approves or sends it back for revision.
102108
```kotlin
103109
fun contentPipeline() = workflow("content-pipeline") {
104110
agents {
105-
agent("writer") { role = "Content Writer"; model = Models.CLAUDE_SONNET_4_5 }
106-
agent("reviewer") { role = "Content Reviewer"; model = Models.GPT_4O }
111+
agent("writer") { role = "Content Writer"; model = Models.GEMINI_3_1_FLASH_LITE }
112+
agent("reviewer") { role = "Content Reviewer"; model = Models.GEMINI_3_1_PRO }
107113
}
108114

109115
rubrics { rubric("content-quality", "content-quality.md") }
@@ -291,7 +297,7 @@ MCP split-pipe connectivity, stub tool implementations, SSE event streaming, and
291297
human-in-the-loop review gate.
292298

293299
**Scenario:** a credit risk analyst agent evaluates a fictional credit-limit increase for
294-
customer `C-42`.
300+
customer `C-42`. Complete the [Getting Started](#getting-started) steps before running this example.
295301

296302
```bash
297303
QUARKUS_PROFILE=inmem ./hensu-server-v0.1.0-beta.1
@@ -312,6 +318,7 @@ Hensu is in **pre-beta**, working toward beta stability.
312318
- Pre-built server binaries are Linux x86_64 only. macOS and ARM targets are planned.
313319
- No observability integration yet (OpenTelemetry, metrics export).
314320
- No native image integration tests yet. The native build is verified by CI, but test coverage runs in JVM mode only.
321+
- OpenAI and DeepSeek models are defined in the DSL but have not been tested end-to-end. Only Anthropic and Google Gemini models are verified.
315322
- APIs and DSL surface may change before beta.
316323

317324
---

assets/logo.png

28.4 KB
Loading

docs/developer-guide-core.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1218,8 +1218,6 @@ HensuFactory.builder()
12181218
| `OPENAI_API_KEY` | OpenAI GPT |
12191219
| `GOOGLE_API_KEY` | Google Gemini |
12201220
| `DEEPSEEK_API_KEY` | DeepSeek |
1221-
| `OPENROUTER_API_KEY` | OpenRouter |
1222-
| `AZURE_OPENAI_KEY` | Azure OpenAI |
12231221

12241222
Environment variables matching `*_API_KEY`, `*_KEY`, `*_SECRET`, or `*_TOKEN` patterns are auto-discovered.
12251223

docs/dsl-reference.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -991,7 +991,6 @@ fun contentPipeline() = workflow("ContentPipeline") {
991991
agent = "researcher"
992992
prompt = """
993993
Research {topic} and provide key facts.
994-
Output as JSON: {"fact1": "...", "fact2": "...", "fact3": "..."}
995994
""".trimIndent()
996995

997996
writes("fact1", "fact2", "fact3")

hensu-dsl/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ fun myWorkflow() = workflow("ContentPipeline") {
2929
}
3030
agent("reviewer") {
3131
role = "Quality Reviewer"
32-
model = Models.GPT_4O
32+
model = Models.GEMINI_3_1_PRO
3333
}
3434
}
3535

integrations/spring-reference-client/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,10 @@ flowchart LR
4444

4545
### 1 — Start hensu-server in inmem profile
4646

47+
The workflow uses Gemini models — export your API key before starting the server:
48+
4749
```bash
50+
export GOOGLE_API_KEY=<your-key>
4851
./gradlew hensu-server:quarkusDev -Dquarkus.profile=inmem
4952
```
5053

working-dir/workflows/content-pipeline.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ fun contentPipeline() = workflow("content-pipeline") {
1313

1414
agents {
1515
agent("writer") { role = "Content Writer"; model = Models.GEMINI_3_1_FLASH_LITE }
16-
agent("reviewer") { role = "Content Reviewer"; model = Models.CLAUDE_SONNET_4_6 }
16+
agent("reviewer") { role = "Content Reviewer"; model = Models.GEMINI_3_1_PRO }
1717
}
1818

1919
rubrics { rubric("content-quality", "content-quality.md") }

0 commit comments

Comments
 (0)