Update documentation for PromptKit adoption
This commit is contained in:
@@ -9,7 +9,7 @@ own IO and presentation mechanics, not framework decisions.
|
||||
External contracts are canonical in the [CLI reference](../cli.md) and
|
||||
[HTTP API reference](../api.md). Promptkit's public engine contract is
|
||||
described by its tagged
|
||||
[Go consumer guide](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.12.0/docs/consumers/pkg-promptkit.md).
|
||||
[Go consumer guide](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/382ccfb14b9630fd8f48c8364dbe2b6159637d71/docs/consumers/pkg-promptkit.md).
|
||||
|
||||
## Components And Collaborators
|
||||
|
||||
@@ -20,11 +20,11 @@ described by its tagged
|
||||
exposes application and captured framework configuration inspection, and
|
||||
owns output files, summaries, and exit codes.
|
||||
- `internal/config` delegates application YAML decoding, default resolution,
|
||||
overrides, and validation ordering to ConfigKit v1.2.0. The CLI supplies only
|
||||
overrides, and validation ordering to ConfigKit v1.2.1. The CLI supplies only
|
||||
explicitly visited application flags as overrides and renders safe structured
|
||||
load diagnostics on stderr. Promptkit uses old-path ConfigKit v0.5.0 to load
|
||||
framework sources under its own definition and format contract. Errors and
|
||||
warnings are written by the owning generation's native diagnostic writer.
|
||||
load diagnostics on stderr. PromptKit uses the same ConfigKit release to
|
||||
load framework sources under its own definition and format contract. Both
|
||||
domains use ConfigKit's native diagnostic writer.
|
||||
- `internal/adapter/http` strictly decodes request DTOs, maps them to Promptkit
|
||||
public values, calls its adapter-owned `Runner` interface, and maps results
|
||||
and errors to HTTP DTOs.
|
||||
@@ -38,7 +38,7 @@ described by its tagged
|
||||
### CLI
|
||||
|
||||
`run` calls `promptkit.Engine.Run`; `render` calls
|
||||
`promptkit.Engine.Prepare`. Both share request mapping for prompt ID/version
|
||||
`promptkit.Engine.Prepare`. Both share request mapping for exact prompt ID
|
||||
and profile selection, optional file inputs, variables, and presence-aware
|
||||
execution overrides. Omitted framework settings remain zero values so Promptkit
|
||||
resolves its own defaults and definition-required inputs.
|
||||
@@ -47,10 +47,10 @@ run/render flag enters only the mapped request. The server uses the same engine
|
||||
setting and retains one backend admission state. Render prepares without
|
||||
generation.
|
||||
|
||||
`inspect prompt` maps the selected ID and optional version to
|
||||
`inspect prompt` maps the selected ID to
|
||||
`promptkit.Engine.InspectPrompt`, then formats Scriptorium-owned inspection
|
||||
data. `inspect profile` maps an explicit profile ID to `Engine.InspectProfile`
|
||||
and formats Scriptorium-owned effective profile data.
|
||||
and formats Scriptorium-owned resolved profile data without backend completion.
|
||||
|
||||
Both paths construct the same full-source engine as execution before inspecting
|
||||
the chosen definition; selected prompts are not filtered out. They do not
|
||||
@@ -79,7 +79,7 @@ adapter's consumer-owned `Runner` interface, and starts the server.
|
||||
|
||||
The command paths assemble the engine from application-selected framework
|
||||
source files and directories plus the schema directory and retry setting.
|
||||
Individual files become import-enabled old-path ConfigKit inputs; directory selections
|
||||
Individual files become import-enabled ConfigKit inputs; directory selections
|
||||
are expanded through Promptkit's directory-input helper. Scriptorium supplies
|
||||
those ordered underlays through Promptkit's public configuration API rather
|
||||
than parsing or mapping framework definitions itself. The server constructs
|
||||
@@ -95,6 +95,9 @@ validation, model, usage, and metadata values directly.
|
||||
The optional HTTP retry count maps to `RunRequest.TransientRetries` without
|
||||
mutating the shared engine. Negative values are rejected before invocation;
|
||||
Promptkit controls retries and backend admission for concurrent requests.
|
||||
CLI and HTTP operation budgets map to PromptKit's `OperationTimeout`; HTTP
|
||||
passes the caller context through unchanged. The public sentinels determine
|
||||
timeout classification, subject to the documented transport limitation.
|
||||
|
||||
Failure mapping uses `errors.Is` against Promptkit's public sentinels and the
|
||||
HTTP reader's Scriptorium-owned containment and size errors. Wrapped reader
|
||||
|
||||
Reference in New Issue
Block a user