Relaxed CLI requirements when defaults are specified in the profile or application defaults
This commit is contained in:
17
README.md
17
README.md
@@ -27,11 +27,12 @@ go run ./cmd/scriptorium run \
|
||||
--profile-id generic.markdown_summary \
|
||||
--input transcript=./examples/fixtures/transcript.md \
|
||||
--input glossary=./examples/fixtures/glossary.yml \
|
||||
--llm-base-url http://localhost:8000/v1 \
|
||||
--model gpt-4o-mini \
|
||||
--out ./out.md
|
||||
```
|
||||
|
||||
This relies on `model_defaults.endpoint` and `model_defaults.model` in the selected profile.
|
||||
You can override either at runtime with `--llm-base-url` and/or `--model`.
|
||||
|
||||
For schema-validated JSON output:
|
||||
|
||||
```bash
|
||||
@@ -78,17 +79,23 @@ Response shape:
|
||||
- `metadata`
|
||||
- `raw_model_output`
|
||||
|
||||
`metadata` includes stable audit fields such as run/profile IDs, profile hash, effective model params, prompt/input hashes, timing, usage, and validation summary.
|
||||
|
||||
## Add a New Prompt Profile
|
||||
|
||||
1. Add a YAML file under `profiles/` with:
|
||||
- `id`, `version`, `expected_inputs`, `templates`, `model_defaults`, `output_format`, `validation`
|
||||
- optional model timeout via `model_defaults.timeout_seconds` (per-run LLM timeout override)
|
||||
2. Use template helpers such as `{{input "transcript"}}`.
|
||||
3. For structured JSON output, set:
|
||||
2. Ensure endpoint/model are available from either:
|
||||
- profile defaults (`model_defaults.endpoint`, `model_defaults.model`), or
|
||||
- request overrides (`--llm-base-url`, `--model`, or HTTP `model.endpoint`/`model.model`).
|
||||
3. Use template helpers such as `{{input "transcript"}}` and template vars like `{{.session_date}}`.
|
||||
4. For structured JSON output, set:
|
||||
- `output_format: json`
|
||||
- `validation.validation_mode: json_schema`
|
||||
- `validation.schema_path: <schema file>`
|
||||
4. Place schema files in `schemas/` and pass `--schema-dir ./schemas` for CLI/serve.
|
||||
5. Place schema files in `schemas/` and pass `--schema-dir ./schemas` for CLI/serve.
|
||||
6. `validation.repair_attempts` is bounded and applies only to structured modes (`json`, `json_schema`).
|
||||
|
||||
## Validation Behavior
|
||||
|
||||
|
||||
Reference in New Issue
Block a user