42 lines
2.0 KiB
Markdown
42 lines
2.0 KiB
Markdown
# PromptKit Integration
|
|
|
|
Notarius pins
|
|
[`gitea.maximumdirect.net/eric/promptkit` v0.2.0](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.2.0)
|
|
as its in-process prompt engine. The upstream
|
|
[Go package consumer guide](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.2.0/docs/consumers/pkg-promptkit.md)
|
|
owns the public engine API, and the upstream
|
|
[format reference](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.2.0/docs/formats.md)
|
|
owns prompt, profile, and schema file contracts.
|
|
|
|
## Supported Boundary
|
|
|
|
Notarius relies on the root `promptkit` package to:
|
|
|
|
- construct an `Engine` with filesystem-backed prompt, schema, and optional
|
|
profile sources;
|
|
- prepare and run a `RunRequest` with named inline artifacts, variables,
|
|
prompt identity, and profile selection;
|
|
- return rendered debug material, validated structured output, selected
|
|
profile and model metadata, and token usage;
|
|
- distinguish structured-output validation failure from execution failure; and
|
|
- identify a missing explicit profile through `ErrProfileNotFound`.
|
|
|
|
Notarius does not use PromptKit's optional `ArtifactReader`. It materializes
|
|
source and reference content itself and supplies owned inline artifacts at the
|
|
adapter boundary. It also retains responsibility for pipeline retries,
|
|
scheduling, debug persistence, redaction, profile provenance, and conversion
|
|
from private model responses into durable domain artifacts.
|
|
|
|
## Notarius Ownership
|
|
|
|
[LLM Runtime Internals](../internal/llm.md) describes how Notarius mounts
|
|
module assets, maps its transport-neutral completion contract, prepares and
|
|
executes requests, validates output, records provenance, captures debug
|
|
material, redacts errors, and preserves timeout ownership.
|
|
[Configuration](../config.md#promptkit-profiles) defines how a Notarius
|
|
configuration selects one PromptKit profile source.
|
|
|
|
PromptKit API or format changes outside this boundary are not implicitly
|
|
supported. Updating the pinned version requires reviewing the adapter and
|
|
profile/configuration contracts against the upstream documentation.
|