Plan the Audita adoption sprint
This commit is contained in:
@@ -4,7 +4,8 @@
|
||||
|
||||
**Status:** Adoption direction and automatic operator-source selection resolved;
|
||||
implementation remains pending. Follow the [master roadmap](library-adoption.md)
|
||||
for shared adoption principles, dependency identities, and sequencing.
|
||||
for shared adoption principles and dependency identities, and the
|
||||
[implementation plan](implementation.md) for sequencing.
|
||||
|
||||
## Baseline and Target
|
||||
|
||||
@@ -37,7 +38,7 @@ execution profile or make provider calls during construction.
|
||||
### Backend Concurrency Ownership — Resolved
|
||||
|
||||
Adopt PromptKit's native per-backend concurrency behavior, including backend
|
||||
defaults and supported configuration and CLI overrides. The purpose is to keep
|
||||
defaults and native configuration. The purpose is to keep
|
||||
requests within the concurrency a backend can accommodate; no separate Audita
|
||||
domain requirement has been identified for an additional limit.
|
||||
|
||||
@@ -48,10 +49,10 @@ otherwise valid PromptKit configuration. Use the shared PromptKit engine so
|
||||
proposal and validation work for the same backend share its admission control.
|
||||
Audita still owns cancellation and deterministic processing around model calls.
|
||||
|
||||
Verify the exact upstream override APIs while wiring the adopted configuration
|
||||
and CLI integrations. Update the architecture policy's finite-admission wording,
|
||||
runtime documentation, examples, and tests with implementation. Remove superseded
|
||||
behavior directly in the major release, with hard-cutover guidance.
|
||||
The selected PromptKit configuration scope does not forward ConfigKit CLI
|
||||
overrides, and request overrides do not set concurrency. Configure limits on
|
||||
native backend resources. Architecture policy, runtime documentation, examples,
|
||||
and tests describe the adopted ownership and hard cutover.
|
||||
|
||||
### Backend and Credential Ownership — Resolved
|
||||
|
||||
@@ -192,61 +193,32 @@ resolver. Include the retired view and its standard replacements in the
|
||||
hard-cutover guidance. The [CommandKit outline](commandkit.md) owns the operator
|
||||
surface and request-preview integration work.
|
||||
|
||||
### Migration Work
|
||||
### Target Request and Source Boundaries
|
||||
|
||||
1. Move to `go.maximumdirect.net/promptkit` together with ConfigKit's new types.
|
||||
Remove the old external catalog dependencies when no longer incorporated;
|
||||
retain PromptKit's built-in catalog rather than disabling it.
|
||||
2. Convert root and collection backends, profiles, and prompts to identified lists
|
||||
with explicit `id` fields. Use sibling `extends: {id: parent}` and complete
|
||||
same-ID replacement records. Typed source builders use ordered slices.
|
||||
Preserve provider settings deliberately: partial same-ID replacements no
|
||||
longer merge fields. Use exact native collection references where collections
|
||||
are selected; mounting does not rewrite stored references.
|
||||
3. Convert the seven embedded prompts into the `audita` collection and update
|
||||
maintained operator examples/fixtures for the resolved replacement workflow.
|
||||
Implement automatic operator imports above the embedded underlay through the
|
||||
shared engine loader, including explicit host and embedded filesystem contexts.
|
||||
Remove prompt version selectors and descriptive `PromptVersion` metadata from
|
||||
requests, registries, inspection, and diagnostics. Response-schema versions
|
||||
are separate and need not change. Keep domain instructions and per-call schemas;
|
||||
this adoption is not a prompt-quality rewrite. Shared instruction variables
|
||||
remain available to templates, while native operator overrides control their
|
||||
inclusion. Domain validation remains enforced after model responses.
|
||||
4. Adapt resource inspection to optional profile fields and separate backend
|
||||
inspection. These describe resources, not completed requests. Use real
|
||||
`PrepareExecution` details and `RunPrepared` for execution of the same captured
|
||||
request. Remove the curated profile view and its supporting projection code;
|
||||
do not duplicate PromptKit's full resolver or construct synthetic requests
|
||||
merely to reproduce that summary. Inspect bundled and unselected partial
|
||||
resources without requiring them to be runnable.
|
||||
5. Implement the resolved backend and credential ownership decision above.
|
||||
Replace application backend/credential configuration with native resources
|
||||
and document the hard cutover. Preserve secret-safe diagnostics using the
|
||||
library's public boundaries and Audita's domain artifact redaction; evaluate
|
||||
actual gaps with synthetic keys.
|
||||
6. Review presence semantics field by field. Null endpoint, credential-source,
|
||||
and whole provider map now allow backend defaults; explicit empty strings
|
||||
clear endpoint/credential sources. Null does not suppress the entire backend
|
||||
provider map. Sampling fields have distinct semantics. Avoid blanket null or
|
||||
zero conversion and document intentional request changes.
|
||||
7. Update captured-source accounting for list indexes and collection prefixes,
|
||||
including inherited/moved content-file origins. Preserve output-collision
|
||||
protection for consumed host documents, including automatic imports, and
|
||||
effective message files. Array positions are addresses, not durable resource
|
||||
identities.
|
||||
8. Keep self-contained embedded response schemas. The new schema rule does not
|
||||
require a bundler for Audita's current schemas. Check custom artifact-reader
|
||||
ownership only where such a reader is actually used. Preserve native retries,
|
||||
structural repair, cancellation, deadlines, and shared engine admission while
|
||||
retaining Audita's domain reconciliation and partial-success outcomes.
|
||||
PromptKit resource sources use identified lists, native sibling `extends`, and
|
||||
complete same-ID replacement records. Qualified references remain explicit.
|
||||
Audita requests, registries, inspection, and diagnostics use prompt IDs without
|
||||
obsolete prompt-version selection or labels. The existing domain instructions,
|
||||
self-contained response schemas, per-call schema and repair controls, and
|
||||
proposal/validator behavior remain distinct from resource format changes.
|
||||
|
||||
Update [configuration](../config.md), [LLM integration](../integrations/openai-compatible-llm.md),
|
||||
[runtime internals](../internal/llm-runtime.md), [prompt guidance](../internal/prompts.md),
|
||||
operator examples, diagnostics metadata documentation, and attribution with the
|
||||
implementation. Standard inspection replaces curated-only disclosure; prompts
|
||||
and provider settings may appear where the library's normal inspection exposes
|
||||
them, with native redaction. Do not accidentally promise old prompt hashes.
|
||||
Resource inspection shows native optional profile fields and backend definitions;
|
||||
prepared execution shows the completed request. Audita executes the captured
|
||||
request it prepared, without a parallel target resolver. Native field-specific
|
||||
null and presence rules govern defaults. Audita retains logical operation
|
||||
budgets, cancellation, truthful partial success, and safe diagnostics.
|
||||
|
||||
Output-collision protection accounts for consumed host documents, including
|
||||
imports, and effective source-relative `content_file` resources. Source metadata
|
||||
tracks inherited and moved values at native list-index and collection paths;
|
||||
array positions are addresses, not durable resource IDs. Native redaction governs
|
||||
standard inspection, while Audita owns its artifact redaction.
|
||||
|
||||
Canonical [configuration](../config.md), [LLM integration](../integrations/openai-compatible-llm.md),
|
||||
[runtime](../internal/llm-runtime.md), and [prompt guidance](../internal/prompts.md)
|
||||
will describe the implemented behavior and cutover, alongside updated examples
|
||||
and attribution. Standard inspection can show prompts and provider settings
|
||||
where the library exposes them; old prompt hashes are not a contract.
|
||||
|
||||
## Acceptance and Upstream Requests
|
||||
|
||||
|
||||
Reference in New Issue
Block a user