Document every config key in config.example.yaml

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
This commit is contained in:
WolfandClaude Fable 5.1 committed 2026-09-30 15:44:32 +02:00
1 parent 58a6a1f28e
commit 1074a2a0c9
1 file changed
+38 -6
+38 -6
View File
@@ -46,6 +46,10 @@ workers:
# `agent` extra.
agent:
backend: auto # auto | api | claude_code | off
model: "" # overrides extract.model and summarise.model when set
timeout: 300.0 # seconds for one model call, either backend
max_tokens: 8192 # the answer's cap per call
cli_path: "" # where the `claude` binary is, if not on PATH
# Title and description in, gate columns out (app/jobs/extract.py). Off by
# default: on the API backend every batch of 20 roles is a paid call. On, a
@@ -56,7 +60,10 @@ agent:
# `app stages extract on|off`) overrides it and needs no restart.
extract:
enabled: false
model: claude-haiku-4-5-20251001
model: claude-haiku-4-5-20251001 # agent.model wins when set
batch_size: 20 # roles per model call
on_ingest: auto # auto: in a pull when a model is reachable | always | never
thinking: off # off | adaptive
# About 60 words on a role: what it is, the stack, where, the pay if stated
# (app/jobs/summarise.py). Off by default. On, each pull summarises the best
@@ -67,7 +74,26 @@ extract:
# `app stages summarise on|off`) overrides it and needs no restart.
summarise:
enabled: false
model: claude-haiku-4-5-20251001
model: claude-haiku-4-5-20251001 # agent.model wins when set
batch_size: 10 # roles per model call
thinking: off # off | adaptive
# on_ingest (auto | always | never) is accepted here and ignored: a pull
# runs summarise when it is on and a model is reachable (app/jobs/cascade.py).
# Only extract reads it.
# Reading the best roles on their own pages, for the hosts whose list carries
# no text (app/jobs/enrich.py); asks no model. A role is read when it has no
# text and an enabled agent with a prompt ranks it ungated among its best
# `top` and at `min_score` or above. `enabled` is only the default for a fresh
# database: the switch under Settings, Sources, Runs (or `app stages enrich
# on|off`) overrides it and needs no restart.
enrich:
enabled: true
top: 500 # rank depth per agent
min_score: 0.5 # 0..1, the score bar
per_board: 200 # reads per board and run
per_run: 1000 # reads per run
retry_days: 7 # days before a page that gave no text is read again
# A role and each agent's prompts as vectors, for the fit term of a score
# (app/jobs/embed.py). Needs the `embeddings` extra; without it `embed` posts
@@ -94,6 +120,9 @@ embed:
# none, except the key an adzuna search needs (or ADZUNA_APP_ID and
# ADZUNA_APP_KEY in the environment, which keeps it out of this file).
sources: {}
# `enabled` is a key every plugin's block takes, but the pull builds its ats and
# search plugins from the subscriptions and does not read it: switch a board
# or a search off on the Sources page instead.
# search:
# adzuna: {app_id: "...", app_key: "..."}
@@ -124,8 +153,9 @@ sources: {}
# without blending them into one paragraph. Votes, gates and limits stay the
# agent's, shared by its prompts. intent, as in config.yaml, is one prompt
# named after the agent.
# The Search agents sub-tab lists and edits them; the order menu on Roles
# picks one by name. Two more, beside the starter in config.yaml:
# enabled (default true) leaves an agent out of the scores and the pull when
# false. The Search agents sub-tab lists and edits them; the order menu on
# Roles picks one by name. Two more, beside the starter in config.yaml:
agents: []
# - name: Remote from Europe
# prompts:
@@ -155,6 +185,8 @@ agents: []
# - {field: remote, values: [hybrid, remote], mode: prefer, weight: 0.05}
# Starter searches, imported once while there are no `search` subscriptions.
# provider is jobindex (Denmark, no key: q, area, pages) or adzuna (the UK and
# most of the EU, a free key: q, country, where, pages). See plugins/search.py.
# provider is a search reader: jobindex (Denmark, no key: q, area, pages),
# adzuna (the UK and most of the EU, a free key: q, country, where, pages) or
# platsbanken (Sweden, no key: q, region: the id of a län, or empty). See
# plugins/readers/.
searches: []