Document resource inspection and source migrations
This commit is contained in:
37
docs/releases/v0.20.0.md
Normal file
37
docs/releases/v0.20.0.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# Promptkit v0.20.0
|
||||
|
||||
This minor release adds generically renderable resource inspection and typed
|
||||
prompt source construction. The Go consumer minimum remains 1.27.0 and
|
||||
ConfigKit remains at v1.1.0.
|
||||
|
||||
## Compatibility And Migration
|
||||
|
||||
`InspectProfile` now returns the resolved profile resource instead of the
|
||||
backend-completed `EffectiveModelParams`. Replace accesses to that field with
|
||||
the optional profile fields; use `Prepare` or `PreparedExecution.Details` for
|
||||
completed request settings. `InspectPrompt` now includes captured messages and
|
||||
uses optional pointers for presence-sensitive fields, including default profile,
|
||||
inputs, input metadata, and output settings. Check pointers before dereferencing.
|
||||
All three resource reports support ordinary JSON and YAML rendering without
|
||||
per-field adapters. See the [consumer guidance](../consumers/pkg-promptkit.md#inspect-a-profile-before-prompt-work).
|
||||
|
||||
After configuration composition and inheritance, profile null endpoint,
|
||||
API-key source, and whole provider map now permit backend defaults during
|
||||
execution as well as appearing absent in resource inspection. Use explicit
|
||||
empty strings to clear endpoint or API-key source. There is no replacement for
|
||||
profile-level suppression of an entire backend provider map; edit backend
|
||||
defaults through composition instead. The required-key rule still applies.
|
||||
See [defaults and overrides](../formats.md#defaults-and-overrides) for the
|
||||
migration example and retained ConfigKit null provenance.
|
||||
|
||||
## Resource Inspection And Sources
|
||||
|
||||
`InspectBackend` reports the resolved backend and configured diagnostics without
|
||||
contacting a provider or deriving diagnostic destinations. Prompt and profile
|
||||
inspection likewise report selected resources independently of request readiness;
|
||||
configuration provenance, requirement analysis, and preparation remain separate.
|
||||
`PromptSource` adds typed programmatic prompt definitions, and `BackendConfig`
|
||||
supports sibling inheritance. ConfigKit continues to own source composition,
|
||||
snapshotting, and relative message-file contexts.
|
||||
|
||||
[COPYRIGHT](https://forge.maximumdirect.net/base-layer/promptkit/src/tag/v0.20.0/COPYRIGHT) | [LICENSE](https://forge.maximumdirect.net/base-layer/promptkit/src/tag/v0.20.0/LICENSE) | [ATTRIBUTION](https://forge.maximumdirect.net/base-layer/promptkit/src/tag/v0.20.0/docs/oss/attribution.md)
|
||||
Reference in New Issue
Block a user