Compare commits
140 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| a0441fb2d1 | |||
| 32547e1e29 | |||
| bcc9ebd2e0 | |||
| c7d4318122 | |||
| 175140ae5a | |||
| 66b98831d3 | |||
| 3e3cc677fb | |||
| 8896d8733b | |||
| 7bbdb55888 | |||
| 79dfd97afa | |||
| 995c309560 | |||
| ea4fec9b1b | |||
| 1de3e1fe38 | |||
| 061f01c081 | |||
| 937b9723d4 | |||
| 367af5feca | |||
| fd73cd0662 | |||
| 81a55bc62c | |||
| 2bc976de10 | |||
| fc568aa0b2 | |||
| b0bfe857fe | |||
| 2ccbee3758 | |||
| 0eee3ec962 | |||
| 130c4cc447 | |||
| f661176b06 | |||
| 3e67743fbf | |||
| 6b8eefd18b | |||
| 682cb84c82 | |||
| dbc345e566 | |||
| afcfae2aea | |||
| eaca50763b | |||
| cb83b8aca6 | |||
| 0b026861a5 | |||
| da8496b45b | |||
| e01b23259a | |||
| 500b0aa1c8 | |||
| fd6e9742a1 | |||
| a6f4d67e15 | |||
| c3ce15a4ab | |||
| 8e8f61f53f | |||
| b7565affe5 | |||
| aba890aa86 | |||
| 0b271267a0 | |||
| a4e97bf102 | |||
| 6ae005ed3a | |||
| 07a55e45f2 | |||
| 2b3875008b | |||
| a51d12d898 | |||
| 9178f3eb91 | |||
| a70fd7bb65 | |||
| 7091b51c87 | |||
| 8627c751a4 | |||
| 6fff3d822c | |||
| a1f12f3185 | |||
| 165cef7aec | |||
| 0221cd4610 | |||
| dfd8da843e | |||
| 29f104fbc0 | |||
| 8669294cf6 | |||
| c9b623b374 | |||
| 15f79ce7b1 | |||
| aa54b8d1c4 | |||
| 60c58260ec | |||
| 8dfe35a1f0 | |||
| 13b60a72ac | |||
| ee40a1bdd2 | |||
| 473fc1f6d7 | |||
| a10a9053b7 | |||
| ec3245c97e | |||
| 8cbb7c0daf | |||
| d40a010538 | |||
| 0cd833513c | |||
| 5e58b6944b | |||
| 0a85ac8cd1 | |||
| 89af2a1281 | |||
| 683689a4f8 | |||
| ddda2f8767 | |||
| 190ec69345 | |||
| b5866dd749 | |||
| c7490b783b | |||
| c7d1b0dca7 | |||
| 9e5ed08635 | |||
| 4bddbbe8f4 | |||
| 1516631a30 | |||
| cf997c2034 | |||
| a0ec67c256 | |||
| 75891b6561 | |||
| 5dc6370a97 | |||
| 4cda3674c4 | |||
| 5ea6f06a6d | |||
| 116bd0e39b | |||
| 208ff42915 | |||
| 972a103a97 | |||
| 2f735aedf9 | |||
| f4c721d934 | |||
| b7a951685b | |||
| abb2461244 | |||
| b268c55783 | |||
| f0182fb2c9 | |||
| 8d05b594e2 | |||
| edaaecc982 | |||
| 2e81c9e61b | |||
| 2b723760d1 | |||
| c5aed7a451 | |||
| d91afc61a4 | |||
| 6eeb0ee9c0 | |||
| b9c232ee63 | |||
| 7291d23587 | |||
| da1d196dc5 | |||
| b0de49a87a | |||
| 27ff580dae | |||
| ece764f19e | |||
| f91a02548e | |||
| 8fbd058b90 | |||
| c8f9a4def9 | |||
| d8b6c0b471 | |||
| 52cd94fcd1 | |||
| f1f72dfe8f | |||
| d4676bc870 | |||
| 64769883ae | |||
| 635674c066 | |||
| 50bc35516a | |||
| 18309f50db | |||
| 60784e7875 | |||
| f3148bfe52 | |||
| f315620bf7 | |||
| 97357d62b9 | |||
| 0c3651fceb | |||
| 5a5d47d36e | |||
| 143c6e9b3a | |||
| 48e4784fcd | |||
| 78af5069c1 | |||
| 18963266d7 | |||
| d039a019cb | |||
| d1c0281053 | |||
| 870e4ca4e6 | |||
| fd82524977 | |||
| 3f76c75919 | |||
| fe764f72d8 | |||
| 26ab566f38 |
2
.gitignore
vendored
2
.gitignore
vendored
@@ -22,7 +22,7 @@
|
|||||||
go.work
|
go.work
|
||||||
go.work.sum
|
go.work.sum
|
||||||
|
|
||||||
# Local ReleaseKit executable
|
# Local ReleaseKit delivery credentials
|
||||||
.releasekit/
|
.releasekit/
|
||||||
|
|
||||||
# env file
|
# env file
|
||||||
|
|||||||
33
README.md
33
README.md
@@ -4,7 +4,7 @@ Promptkit is a reusable Go library for preparing and executing prompt-defined
|
|||||||
LLM workflows. Its module path is:
|
LLM workflows. Its module path is:
|
||||||
|
|
||||||
```text
|
```text
|
||||||
gitea.maximumdirect.net/eric/promptkit
|
go.maximumdirect.net/promptkit
|
||||||
```
|
```
|
||||||
|
|
||||||
The root `promptkit` package provides the supported public engine. Consumers
|
The root `promptkit` package provides the supported public engine. Consumers
|
||||||
@@ -21,15 +21,21 @@ Run the maintained offline preparation example from the repository root:
|
|||||||
go run ./examples/go-library/prepare
|
go run ./examples/go-library/prepare
|
||||||
```
|
```
|
||||||
|
|
||||||
It loads a repository-local prompt, supplies a programmatic profile and inline
|
It composes two explicitly selected synthetic collections, imports
|
||||||
input, inspects the captured configuration, and prints deterministic
|
source-relative prompt content, supplies an inline input, and prepares through
|
||||||
preparation metadata without contacting a provider or requiring credentials.
|
a scoped view. The example also demonstrates collection inventories and
|
||||||
|
namespace-filtered discovery, without contacting a provider or requiring
|
||||||
|
credentials.
|
||||||
The [consumer guide](docs/consumers/pkg-promptkit.md) also shows a local backend,
|
The [consumer guide](docs/consumers/pkg-promptkit.md) also shows a local backend,
|
||||||
ordered file/embedded sources, programmatic mappings, and how to replace an
|
ordered file/embedded sources, programmatic mappings, and how to replace an
|
||||||
engine when source files change. Read the
|
engine when source files change. Applications adapting the prior keyed
|
||||||
[example source](examples/go-library/prepare/main.go), the
|
configuration or versioned-prompt format can consult the
|
||||||
|
[configuration migration guide](docs/consumers/configuration-migration.md).
|
||||||
|
See the [example source](examples/go-library/prepare/main.go), the
|
||||||
[Go package consumer guide](docs/consumers/pkg-promptkit.md), and the
|
[Go package consumer guide](docs/consumers/pkg-promptkit.md), and the
|
||||||
[framework format reference](docs/formats.md) to build a consumer workflow.
|
[framework format reference](docs/formats.md) to build a consumer workflow.
|
||||||
|
The consumer guide also covers explicit, live smoke diagnostics and interpreting
|
||||||
|
their factual reports; they are separate from the offline quickstart.
|
||||||
|
|
||||||
Contributors should start with the [development guide](docs/development.md).
|
Contributors should start with the [development guide](docs/development.md).
|
||||||
The [architecture policy](docs/policy/architecture.md) defines the library
|
The [architecture policy](docs/policy/architecture.md) defines the library
|
||||||
@@ -37,6 +43,21 @@ boundary and constraints that framework work must preserve.
|
|||||||
|
|
||||||
## Release Guidance
|
## Release Guidance
|
||||||
|
|
||||||
|
The [v0.17.0 release notes](docs/releases/v0.17.0.md) cover the vanity module
|
||||||
|
path, ConfigKit v1, identified resource lists, removal of prompt-version
|
||||||
|
metadata, and the Go 1.27 minimum. This is a breaking pre-v1 migration.
|
||||||
|
|
||||||
|
Consumers using the former Go module path should follow the
|
||||||
|
[module-path migration guidance](docs/consumers/configuration-migration.md#update-go-imports).
|
||||||
|
|
||||||
|
The [v0.16.0 release notes](docs/releases/v0.16.0.md) cover explicit smoke
|
||||||
|
diagnostics, configuration collections, scoped engine views, and discovery.
|
||||||
|
Upgrading consumers should also review the current identified-resource and
|
||||||
|
ConfigKit v1 changes in the [migration guide](docs/consumers/configuration-migration.md).
|
||||||
|
|
||||||
|
The [v0.15.0 release notes](docs/releases/v0.15.0.md) cover error-only
|
||||||
|
validation of concrete requests with `Engine.ValidateRequest`.
|
||||||
|
|
||||||
Consumers upgrading to `v0.12.0` should read the
|
Consumers upgrading to `v0.12.0` should read the
|
||||||
[v0.12.0 release notes](docs/releases/v0.12.0.md) for the intentional ConfigKit
|
[v0.12.0 release notes](docs/releases/v0.12.0.md) for the intentional ConfigKit
|
||||||
configuration and public construction API migration.
|
configuration and public construction API migration.
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import (
|
|||||||
"sync/atomic"
|
"sync/atomic"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/promptkit"
|
"go.maximumdirect.net/promptkit"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestAppendedMessageRoleConstantsAreStrings(t *testing.T) {
|
func TestAppendedMessageRoleConstantsAreStrings(t *testing.T) {
|
||||||
|
|||||||
@@ -4,8 +4,8 @@ import (
|
|||||||
"context"
|
"context"
|
||||||
"errors"
|
"errors"
|
||||||
|
|
||||||
artifactadapter "gitea.maximumdirect.net/eric/promptkit/internal/artifact"
|
artifactadapter "go.maximumdirect.net/promptkit/internal/artifact"
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/domain"
|
"go.maximumdirect.net/promptkit/internal/domain"
|
||||||
)
|
)
|
||||||
|
|
||||||
var errNilArtifactReaderResponse = errors.New("artifact reader returned nil artifact without error")
|
var errNilArtifactReaderResponse = errors.New("artifact reader returned nil artifact without error")
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ import (
|
|||||||
"context"
|
"context"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/domain"
|
"go.maximumdirect.net/promptkit/internal/domain"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestPublicArtifactReaderAdapterCopiesBody(t *testing.T) {
|
func TestPublicArtifactReaderAdapterCopiesBody(t *testing.T) {
|
||||||
|
|||||||
@@ -8,8 +8,8 @@ import (
|
|||||||
"testing"
|
"testing"
|
||||||
"testing/fstest"
|
"testing/fstest"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/ConfigKit"
|
"go.maximumdirect.net/configkit"
|
||||||
"gitea.maximumdirect.net/eric/promptkit"
|
"go.maximumdirect.net/promptkit"
|
||||||
)
|
)
|
||||||
|
|
||||||
var (
|
var (
|
||||||
@@ -71,7 +71,7 @@ func newAssembledWorkflowFixture(b *testing.B, name string) assembledWorkflowFix
|
|||||||
message := "Hello {{.name}}"
|
message := "Hello {{.name}}"
|
||||||
response := "ok"
|
response := "ok"
|
||||||
output := map[string]any{"format": "text", "validation_mode": "none"}
|
output := map[string]any{"format": "text", "validation_mode": "none"}
|
||||||
profile := map[string]any{"endpoint": "http://example.test/v1", "model": "benchmark-model"}
|
profile := map[string]any{"id": "profile", "endpoint": "http://example.test/v1", "model": "benchmark-model"}
|
||||||
options := []promptkit.Option{promptkit.WithLLMClient(assembledWorkflowClient{content: response})}
|
options := []promptkit.Option{promptkit.WithLLMClient(assembledWorkflowClient{content: response})}
|
||||||
var expectedMessage string
|
var expectedMessage string
|
||||||
|
|
||||||
@@ -99,12 +99,12 @@ func newAssembledWorkflowFixture(b *testing.B, name string) assembledWorkflowFix
|
|||||||
}
|
}
|
||||||
|
|
||||||
config := map[string]any{
|
config := map[string]any{
|
||||||
"profiles": map[string]any{"profile": profile},
|
"profiles": []any{profile},
|
||||||
"prompts": map[string]any{"workflow": map[string]any{"v1": map[string]any{
|
"prompts": []any{map[string]any{"id": "workflow",
|
||||||
"default_profile": "profile",
|
"default_profile": "profile",
|
||||||
"messages": []any{map[string]any{"role": "user", "content": message}},
|
"messages": []any{map[string]any{"role": "user", "content": message}},
|
||||||
"output": output,
|
"output": output,
|
||||||
}}},
|
}},
|
||||||
}
|
}
|
||||||
engine, err := promptkit.NewEngine(promptkit.Config{Sources: promptkit.ConfigurationSources{Main: &configkit.Input{
|
engine, err := promptkit.NewEngine(promptkit.Config{Sources: promptkit.ConfigurationSources{Main: &configkit.Input{
|
||||||
Source: configkit.Mapping("assembled workflow benchmark", config),
|
Source: configkit.Mapping("assembled workflow benchmark", config),
|
||||||
@@ -113,7 +113,7 @@ func newAssembledWorkflowFixture(b *testing.B, name string) assembledWorkflowFix
|
|||||||
b.Fatal(err)
|
b.Fatal(err)
|
||||||
}
|
}
|
||||||
request := promptkit.RunRequest{
|
request := promptkit.RunRequest{
|
||||||
PromptID: "workflow", PromptVersion: "v1", Vars: map[string]string{"name": "Ada"},
|
PromptID: "workflow", Vars: map[string]string{"name": "Ada"},
|
||||||
}
|
}
|
||||||
return assembledWorkflowFixture{
|
return assembledWorkflowFixture{
|
||||||
engine: engine, request: request, expectedMessage: expectedMessage, response: response,
|
engine: engine, request: request, expectedMessage: expectedMessage, response: response,
|
||||||
@@ -127,7 +127,7 @@ func verifyAssembledWorkflowFixture(b *testing.B, fixture assembledWorkflowFixtu
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
b.Fatal(err)
|
b.Fatal(err)
|
||||||
}
|
}
|
||||||
if prepared.PromptID != "workflow" || prepared.PromptVersion != "v1" || len(prepared.Messages) != 1 ||
|
if prepared.PromptID != "workflow" || len(prepared.Messages) != 1 ||
|
||||||
prepared.Messages[0].Content != fixture.expectedMessage {
|
prepared.Messages[0].Content != fixture.expectedMessage {
|
||||||
b.Fatalf("prepared fixture output is invalid: %+v", prepared)
|
b.Fatalf("prepared fixture output is invalid: %+v", prepared)
|
||||||
}
|
}
|
||||||
|
|||||||
91
backends.go
91
backends.go
@@ -1,25 +1,28 @@
|
|||||||
package promptkit
|
package promptkit
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"gitea.maximumdirect.net/eric/ConfigKit"
|
"go.maximumdirect.net/configkit"
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/backend"
|
"go.maximumdirect.net/promptkit/internal/backend"
|
||||||
)
|
)
|
||||||
|
|
||||||
// BackendOpenRouter identifies the maintained OpenRouter backend.
|
// BackendOpenRouter is the conventional ID for an OpenRouter backend.
|
||||||
const BackendOpenRouter = backend.OpenRouterID
|
const BackendOpenRouter = backend.OpenRouterID
|
||||||
|
|
||||||
// BackendRakestrawHome identifies the maintained Rakestrawhome backend.
|
// BackendRakestrawHome is the conventional ID for a Rakestrawhome backend.
|
||||||
const BackendRakestrawHome = backend.RakestrawHomeID
|
const BackendRakestrawHome = backend.RakestrawHomeID
|
||||||
|
|
||||||
// BackendLocal is a conventional ID for a caller-configured local backend.
|
// BackendLocal is a conventional ID for a caller-configured local backend.
|
||||||
const BackendLocal = "local"
|
const BackendLocal = "local"
|
||||||
|
|
||||||
// BackendConfig is a presence-aware convenience value for a keyed backend
|
// BackendConfig is a presence-aware convenience value for an identified backend
|
||||||
// definition. Nil pointer fields are omitted, while non-nil pointers preserve
|
// definition. Nil pointer fields are omitted, while non-nil pointers preserve
|
||||||
// explicit zero or blank values. A nil ExtraParams map is omitted; a non-nil
|
// explicit zero or blank values. A nil ExtraParams map is omitted; a non-nil
|
||||||
// empty map supplies an empty mapping. Use raw ConfigKit Mapping inputs for
|
// empty map supplies an empty mapping. A nil SmokeTests pointer is omitted; a
|
||||||
// explicit null. BackendConfig has no stable JSON representation.
|
// non-nil pointer supplies a smoke_tests mapping. Use raw ConfigKit Mapping
|
||||||
|
// inputs for explicit null. BackendConfig has no stable JSON representation.
|
||||||
type BackendConfig struct {
|
type BackendConfig struct {
|
||||||
|
// ID is the local backend identity within its resource list.
|
||||||
|
ID string
|
||||||
// Endpoint is the required absolute HTTP(S) base URL after all layers merge.
|
// Endpoint is the required absolute HTTP(S) base URL after all layers merge.
|
||||||
Endpoint *string
|
Endpoint *string
|
||||||
// APIKeyEnv optionally names an environment variable, not a credential.
|
// APIKeyEnv optionally names an environment variable, not a credential.
|
||||||
@@ -31,17 +34,55 @@ type BackendConfig struct {
|
|||||||
QueueCapacity *int
|
QueueCapacity *int
|
||||||
// ExtraParams supplies JSON-compatible provider request defaults.
|
// ExtraParams supplies JSON-compatible provider request defaults.
|
||||||
ExtraParams map[string]any
|
ExtraParams map[string]any
|
||||||
|
// SmokeTests supplies optional diagnostic defaults and HTTP probe settings.
|
||||||
|
SmokeTests *BackendSmokeTestConfig
|
||||||
}
|
}
|
||||||
|
|
||||||
// BackendSource creates a labeled ConfigKit mapping from keyed backend values.
|
// BackendSmokeTestConfig contains optional diagnostic settings associated with
|
||||||
|
// a backend. Nil nested fields are omitted by BackendSource.
|
||||||
|
type BackendSmokeTestConfig struct {
|
||||||
|
// DefaultProfile is the exact profile ID selected as the backend's
|
||||||
|
// diagnostic inference default. A supplied value must not be blank; the ID
|
||||||
|
// is resolved only when that default is selected.
|
||||||
|
DefaultProfile *string
|
||||||
|
// Reachability optionally selects a full HTTP destination for reachability
|
||||||
|
// diagnostics. A nil endpoint uses the effective backend endpoint.
|
||||||
|
Reachability *ReachabilityProbeConfig
|
||||||
|
// Authentication optionally declares a named authentication diagnostic.
|
||||||
|
// A supplied object requires Kind.
|
||||||
|
Authentication *AuthenticationProbeConfig
|
||||||
|
}
|
||||||
|
|
||||||
|
// ReachabilityProbeConfig configures an optional reachability destination.
|
||||||
|
type ReachabilityProbeConfig struct {
|
||||||
|
// Endpoint is an absolute HTTP(S) URL, including any desired path or query.
|
||||||
|
// Nil selects the effective backend endpoint; an explicit blank value is
|
||||||
|
// invalid.
|
||||||
|
Endpoint *string
|
||||||
|
}
|
||||||
|
|
||||||
|
// AuthenticationProbeConfig configures an optional named authentication
|
||||||
|
// diagnostic.
|
||||||
|
type AuthenticationProbeConfig struct {
|
||||||
|
// Kind selects the authentication adapter. Supported values are "none" and
|
||||||
|
// "openrouter_key"; surrounding whitespace and case are normalized.
|
||||||
|
Kind *string
|
||||||
|
// Endpoint is an absolute HTTP(S) URL, including any desired path or query.
|
||||||
|
// Nil selects the adapter's backend-relative destination; an explicit blank
|
||||||
|
// value is invalid.
|
||||||
|
Endpoint *string
|
||||||
|
}
|
||||||
|
|
||||||
|
// BackendSource creates a labeled ConfigKit mapping containing backend records
|
||||||
|
// in caller order. IDs are explicit and duplicates are left for loading to reject.
|
||||||
// It encodes fields without validating them; NewEngine validates the final
|
// It encodes fields without validating them; NewEngine validates the final
|
||||||
// effective configuration after all selected source layers are combined.
|
// effective configuration after all selected source layers are combined.
|
||||||
// Mapping captures a copy of supported input values at creation; unsupported
|
// Mapping captures a copy of supported input values at creation; unsupported
|
||||||
// values fail when the source is loaded.
|
// values fail when the source is loaded.
|
||||||
func BackendSource(label string, backends map[string]BackendConfig) configkit.Source {
|
func BackendSource(label string, backends []BackendConfig) configkit.Source {
|
||||||
definitions := make(map[string]any, len(backends))
|
definitions := make([]any, 0, len(backends))
|
||||||
for id, config := range backends {
|
for _, config := range backends {
|
||||||
fields := make(map[string]any)
|
fields := map[string]any{"id": config.ID}
|
||||||
if config.Endpoint != nil {
|
if config.Endpoint != nil {
|
||||||
fields["endpoint"] = *config.Endpoint
|
fields["endpoint"] = *config.Endpoint
|
||||||
}
|
}
|
||||||
@@ -57,7 +98,31 @@ func BackendSource(label string, backends map[string]BackendConfig) configkit.So
|
|||||||
if config.ExtraParams != nil {
|
if config.ExtraParams != nil {
|
||||||
fields["extra_params"] = providerMapForMapping(config.ExtraParams)
|
fields["extra_params"] = providerMapForMapping(config.ExtraParams)
|
||||||
}
|
}
|
||||||
definitions[id] = fields
|
if config.SmokeTests != nil {
|
||||||
|
smokeTests := make(map[string]any)
|
||||||
|
if config.SmokeTests.DefaultProfile != nil {
|
||||||
|
smokeTests["default_profile"] = *config.SmokeTests.DefaultProfile
|
||||||
|
}
|
||||||
|
if config.SmokeTests.Reachability != nil {
|
||||||
|
reachability := make(map[string]any)
|
||||||
|
if config.SmokeTests.Reachability.Endpoint != nil {
|
||||||
|
reachability["endpoint"] = *config.SmokeTests.Reachability.Endpoint
|
||||||
|
}
|
||||||
|
smokeTests["reachability"] = reachability
|
||||||
|
}
|
||||||
|
if config.SmokeTests.Authentication != nil {
|
||||||
|
authentication := make(map[string]any)
|
||||||
|
if config.SmokeTests.Authentication.Kind != nil {
|
||||||
|
authentication["kind"] = *config.SmokeTests.Authentication.Kind
|
||||||
|
}
|
||||||
|
if config.SmokeTests.Authentication.Endpoint != nil {
|
||||||
|
authentication["endpoint"] = *config.SmokeTests.Authentication.Endpoint
|
||||||
|
}
|
||||||
|
smokeTests["authentication"] = authentication
|
||||||
|
}
|
||||||
|
fields["smoke_tests"] = smokeTests
|
||||||
|
}
|
||||||
|
definitions = append(definitions, fields)
|
||||||
}
|
}
|
||||||
return configkit.Mapping(label, map[string]any{"backends": definitions})
|
return configkit.Mapping(label, map[string]any{"backends": definitions})
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -7,8 +7,8 @@ import (
|
|||||||
"testing"
|
"testing"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/ConfigKit"
|
"go.maximumdirect.net/configkit"
|
||||||
"gitea.maximumdirect.net/eric/promptkit"
|
"go.maximumdirect.net/promptkit"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestEngineLimitsInjectedClientConcurrency(t *testing.T) {
|
func TestEngineLimitsInjectedClientConcurrency(t *testing.T) {
|
||||||
@@ -247,11 +247,12 @@ func newBackendCapacityEngine(
|
|||||||
promptID, content = "input-prompt", `{{input "input"}}`
|
promptID, content = "input-prompt", `{{input "input"}}`
|
||||||
inputs = []any{map[string]any{"name": "input", "required": true}}
|
inputs = []any{map[string]any{"name": "input", "required": true}}
|
||||||
}
|
}
|
||||||
backend := map[string]any{"endpoint": "http://backend.example/v1", "concurrency_limit": limit}
|
backend := map[string]any{"id": "limited", "endpoint": "http://backend.example/v1", "concurrency_limit": limit}
|
||||||
if queueCapacity != nil {
|
if queueCapacity != nil {
|
||||||
backend["queue_capacity"] = *queueCapacity
|
backend["queue_capacity"] = *queueCapacity
|
||||||
}
|
}
|
||||||
definition := map[string]any{
|
definition := map[string]any{
|
||||||
|
"id": promptID,
|
||||||
"default_profile": "profile",
|
"default_profile": "profile",
|
||||||
"messages": []any{map[string]any{"role": "user", "content": content}},
|
"messages": []any{map[string]any{"role": "user", "content": content}},
|
||||||
"output": map[string]any{"format": "text", "validation_mode": "none"},
|
"output": map[string]any{"format": "text", "validation_mode": "none"},
|
||||||
@@ -265,9 +266,9 @@ func newBackendCapacityEngine(
|
|||||||
}
|
}
|
||||||
engine, err := promptkit.NewEngine(promptkit.Config{Sources: promptkit.ConfigurationSources{Main: &configkit.Input{
|
engine, err := promptkit.NewEngine(promptkit.Config{Sources: promptkit.ConfigurationSources{Main: &configkit.Input{
|
||||||
Source: configkit.Mapping("capacity fixture", map[string]any{
|
Source: configkit.Mapping("capacity fixture", map[string]any{
|
||||||
"backends": map[string]any{"limited": backend},
|
"backends": []any{backend},
|
||||||
"profiles": map[string]any{"profile": map[string]any{"backend": "limited", "model": "model"}},
|
"profiles": []any{map[string]any{"id": "profile", "backend": "limited", "model": "model"}},
|
||||||
"prompts": map[string]any{promptID: map[string]any{"1": definition}},
|
"prompts": []any{definition},
|
||||||
}),
|
}),
|
||||||
}}}, options...)
|
}}}, options...)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
|||||||
233
configuration_diff_contract_test.go
Normal file
233
configuration_diff_contract_test.go
Normal file
@@ -0,0 +1,233 @@
|
|||||||
|
package promptkit_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"go.maximumdirect.net/configkit"
|
||||||
|
"go.maximumdirect.net/promptkit"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestConfigurationInspectionDiffsCapturedValues(t *testing.T) {
|
||||||
|
left := comparisonInspection(t, "earlier-model")
|
||||||
|
right := comparisonInspection(t, "later-model")
|
||||||
|
|
||||||
|
differences, err := left.Diff(right)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("compare captured configurations: %v", err)
|
||||||
|
}
|
||||||
|
if len(differences) != 1 {
|
||||||
|
t.Fatalf("difference count = %d, want 1: %+v", len(differences), differences)
|
||||||
|
}
|
||||||
|
difference := differences[0]
|
||||||
|
if got, want := difference.Path.String(), "/profiles"; got != want {
|
||||||
|
t.Fatalf("difference path = %q, want %q", got, want)
|
||||||
|
}
|
||||||
|
if !strings.Contains(difference.Left.YAML, "earlier-model") || !strings.Contains(difference.Right.YAML, "later-model") {
|
||||||
|
t.Fatalf("difference snapshots = (%q, %q)", difference.Left.YAML, difference.Right.YAML)
|
||||||
|
}
|
||||||
|
|
||||||
|
reversed, err := right.Diff(left)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("compare reversed configurations: %v", err)
|
||||||
|
}
|
||||||
|
if len(reversed) != 1 || reversed[0].Path.String() != difference.Path.String() ||
|
||||||
|
!strings.Contains(reversed[0].Left.YAML, "later-model") ||
|
||||||
|
!strings.Contains(reversed[0].Right.YAML, "earlier-model") {
|
||||||
|
t.Fatalf("reversed difference = %+v", reversed)
|
||||||
|
}
|
||||||
|
|
||||||
|
equal := comparisonInspection(t, "earlier-model")
|
||||||
|
if equal, err := left.Diff(equal); err != nil || len(equal) != 0 {
|
||||||
|
t.Fatalf("compare equal configurations = (%+v, %v), want no differences", equal, err)
|
||||||
|
}
|
||||||
|
if equal, err := left.Diff(left); err != nil || len(equal) != 0 {
|
||||||
|
t.Fatalf("compare view with itself = (%+v, %v), want no differences", equal, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestConfigurationInspectionDiffRejectsZeroViews(t *testing.T) {
|
||||||
|
valid := comparisonInspection(t, "current-model")
|
||||||
|
var zero promptkit.ConfigurationInspection
|
||||||
|
|
||||||
|
for _, comparison := range []struct {
|
||||||
|
name string
|
||||||
|
left, right promptkit.ConfigurationInspection
|
||||||
|
}{
|
||||||
|
{name: "zero left", left: zero, right: valid},
|
||||||
|
{name: "zero right", left: valid, right: zero},
|
||||||
|
{name: "both zero", left: zero, right: zero},
|
||||||
|
} {
|
||||||
|
t.Run(comparison.name, func(t *testing.T) {
|
||||||
|
differences, err := comparison.left.Diff(comparison.right)
|
||||||
|
if !errors.Is(err, promptkit.ErrInvalidConfig) || len(differences) != 0 {
|
||||||
|
t.Fatalf("Diff() = (%+v, %v), want ErrInvalidConfig and no records", differences, err)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestConfigurationInspectionDiffIgnoresSourceHistory(t *testing.T) {
|
||||||
|
left := comparisonInspectionFrom(t, "earlier source", "same-model", nil)
|
||||||
|
right := comparisonInspectionFrom(t, "later source", "same-model", nil)
|
||||||
|
if !hasSourceLabel(left, "earlier source") || !hasSourceLabel(right, "later source") {
|
||||||
|
t.Fatal("comparison fixtures did not retain their distinct source labels")
|
||||||
|
}
|
||||||
|
|
||||||
|
differences, err := left.Diff(right)
|
||||||
|
if err != nil || len(differences) != 0 {
|
||||||
|
t.Fatalf("compare equal effective values with different sources = (%+v, %v), want no differences", differences, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestConfigurationInspectionDiffReportsPresenceAndSequences(t *testing.T) {
|
||||||
|
left := comparisonInspectionFrom(t, "before", "same-model", map[string]any{
|
||||||
|
"sequence": []any{"earlier", "unchanged"},
|
||||||
|
})
|
||||||
|
right := comparisonInspectionFrom(t, "after", "same-model", map[string]any{
|
||||||
|
"nullable": nil,
|
||||||
|
"sequence": []any{"later", "unchanged"},
|
||||||
|
})
|
||||||
|
|
||||||
|
differences, err := left.Diff(right)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("compare presence and sequence values: %v", err)
|
||||||
|
}
|
||||||
|
if len(differences) != 1 || differences[0].Path.String() != "/backends" {
|
||||||
|
t.Fatalf("atomic backend list difference = %+v", differences)
|
||||||
|
}
|
||||||
|
difference := differences[0]
|
||||||
|
if !difference.Left.Present || !difference.Right.Present ||
|
||||||
|
strings.Contains(difference.Left.YAML, "nullable:") || !strings.Contains(difference.Right.YAML, "nullable: null") ||
|
||||||
|
!strings.Contains(difference.Left.YAML, "earlier") || !strings.Contains(difference.Right.YAML, "later") {
|
||||||
|
t.Fatalf("atomic sequence snapshots = %+v", difference)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestConfigurationInspectionDiffProtectsSensitiveValuesAndReturnedRecords(t *testing.T) {
|
||||||
|
left := comparisonInspectionFrom(t, "before", "same-model", map[string]any{
|
||||||
|
"token": "left-secret-sentinel",
|
||||||
|
"visible": "before-value",
|
||||||
|
})
|
||||||
|
right := comparisonInspectionFrom(t, "after", "same-model", map[string]any{
|
||||||
|
"token": "right-secret-sentinel",
|
||||||
|
"visible": "after-value",
|
||||||
|
})
|
||||||
|
|
||||||
|
differences, err := left.Diff(right)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("compare sensitive values: %v", err)
|
||||||
|
}
|
||||||
|
if len(differences) != 1 || differences[0].Path.String() != "/backends" {
|
||||||
|
t.Fatalf("sensitive backend list difference = %+v", differences)
|
||||||
|
}
|
||||||
|
secret := differences[0]
|
||||||
|
if !secret.Left.Redacted || !secret.Right.Redacted || !secret.HiddenChanged {
|
||||||
|
t.Fatalf("sensitive difference = %+v", secret)
|
||||||
|
}
|
||||||
|
if strings.Contains(secret.Left.YAML, "left-secret-sentinel") || strings.Contains(secret.Left.YAML, "right-secret-sentinel") ||
|
||||||
|
strings.Contains(secret.Right.YAML, "left-secret-sentinel") || strings.Contains(secret.Right.YAML, "right-secret-sentinel") {
|
||||||
|
t.Fatalf("sensitive snapshots disclosed a value: %+v", secret)
|
||||||
|
}
|
||||||
|
if !strings.Contains(secret.Left.YAML, "before-value") || !strings.Contains(secret.Right.YAML, "after-value") {
|
||||||
|
t.Fatalf("public sibling missing from snapshots: %+v", secret)
|
||||||
|
}
|
||||||
|
|
||||||
|
differences[0].Path = configkit.Keys("caller", "mutation")
|
||||||
|
differences[0].Left.YAML = "caller mutation"
|
||||||
|
differences[0].Right.YAML = "caller mutation"
|
||||||
|
again, err := left.Diff(right)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("repeat comparison after mutating returned records: %v", err)
|
||||||
|
}
|
||||||
|
if len(again) != 1 {
|
||||||
|
t.Fatalf("repeat difference count = %d, want 1: %+v", len(again), again)
|
||||||
|
}
|
||||||
|
againByPath := differencesByPath(again)
|
||||||
|
if _, exists := againByPath["/caller/mutation"]; exists {
|
||||||
|
t.Fatal("mutating returned path reached retained inspection")
|
||||||
|
}
|
||||||
|
if _, exists := againByPath["/backends"]; !exists {
|
||||||
|
t.Fatalf("original backend path was lost after mutation: %+v", again)
|
||||||
|
}
|
||||||
|
for _, difference := range again {
|
||||||
|
if difference.Left.YAML == "caller mutation" || difference.Right.YAML == "caller mutation" {
|
||||||
|
t.Fatalf("mutating returned snapshots reached retained inspection: %+v", difference)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestConfigurationInspectionDiffMasksSensitiveShapeReplacement(t *testing.T) {
|
||||||
|
left := comparisonInspectionFrom(t, "before", "same-model", map[string]any{
|
||||||
|
"details": map[string]any{
|
||||||
|
"token": "nested-secret-sentinel",
|
||||||
|
"label": "public detail",
|
||||||
|
},
|
||||||
|
})
|
||||||
|
right := comparisonInspectionFrom(t, "after", "same-model", map[string]any{
|
||||||
|
"details": "replacement",
|
||||||
|
})
|
||||||
|
|
||||||
|
differences, err := left.Diff(right)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("compare sensitive shape replacement: %v", err)
|
||||||
|
}
|
||||||
|
if len(differences) != 1 || differences[0].Path.String() != "/backends" {
|
||||||
|
t.Fatalf("shape replacement differences = %+v", differences)
|
||||||
|
}
|
||||||
|
difference := differences[0]
|
||||||
|
if !difference.Left.Redacted || !difference.Right.Redacted || !difference.HiddenChanged {
|
||||||
|
t.Fatalf("shape replacement masking = %+v", difference)
|
||||||
|
}
|
||||||
|
if strings.Contains(difference.Left.YAML, "nested-secret-sentinel") || strings.Contains(difference.Right.YAML, "nested-secret-sentinel") {
|
||||||
|
t.Fatalf("shape replacement disclosed a sensitive value: %+v", difference)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func comparisonInspection(t *testing.T, model string) promptkit.ConfigurationInspection {
|
||||||
|
t.Helper()
|
||||||
|
return comparisonInspectionFrom(t, "comparison fixture", model, nil)
|
||||||
|
}
|
||||||
|
|
||||||
|
func comparisonInspectionFrom(t *testing.T, source, model string, extraParams map[string]any) promptkit.ConfigurationInspection {
|
||||||
|
t.Helper()
|
||||||
|
backend := map[string]any{"id": "local", "endpoint": "https://example.invalid/v1"}
|
||||||
|
if extraParams != nil {
|
||||||
|
backend["extra_params"] = extraParams
|
||||||
|
}
|
||||||
|
engine, err := promptkit.NewEngine(promptkit.Config{Sources: promptkit.ConfigurationSources{
|
||||||
|
Underlays: []configkit.Underlay{{Inputs: []configkit.Input{{Source: configkit.Mapping(source, map[string]any{
|
||||||
|
"backends": []any{backend},
|
||||||
|
"profiles": []any{map[string]any{
|
||||||
|
"id": "offline", "backend": "local",
|
||||||
|
"model": model,
|
||||||
|
}},
|
||||||
|
})}}}},
|
||||||
|
}})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("construct comparison engine: %v", err)
|
||||||
|
}
|
||||||
|
inspection, err := engine.InspectConfiguration()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("inspect comparison engine: %v", err)
|
||||||
|
}
|
||||||
|
return inspection
|
||||||
|
}
|
||||||
|
|
||||||
|
func differencesByPath(differences []configkit.Difference) map[string]configkit.Difference {
|
||||||
|
byPath := make(map[string]configkit.Difference, len(differences))
|
||||||
|
for _, difference := range differences {
|
||||||
|
byPath[difference.Path.String()] = difference
|
||||||
|
}
|
||||||
|
return byPath
|
||||||
|
}
|
||||||
|
|
||||||
|
func hasSourceLabel(view promptkit.ConfigurationInspection, label string) bool {
|
||||||
|
for _, source := range view.Sources() {
|
||||||
|
if source.Label == label {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
@@ -4,8 +4,8 @@ import (
|
|||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/ConfigKit"
|
"go.maximumdirect.net/configkit"
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/configuration"
|
"go.maximumdirect.net/promptkit/internal/configuration"
|
||||||
)
|
)
|
||||||
|
|
||||||
// ConfigurationInspection is a read-only view of one Engine's captured
|
// ConfigurationInspection is a read-only view of one Engine's captured
|
||||||
@@ -27,6 +27,23 @@ func (e *Engine) InspectConfiguration() (ConfigurationInspection, error) {
|
|||||||
return ConfigurationInspection{source: e.internal.InspectConfiguration()}, nil
|
return ConfigurationInspection{source: e.internal.InspectConfiguration()}, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Diff compares this view's captured effective configuration with other. This
|
||||||
|
// view is the earlier (left) value and other is the later (right) value. The
|
||||||
|
// comparison delegates to ConfigKit's frozen effective-value semantics, so
|
||||||
|
// source or resolution history alone does not create differences. It does not
|
||||||
|
// reread external sources or compare referenced file contents, resolved
|
||||||
|
// credential contents, later execution preparation, or request-specific
|
||||||
|
// overrides. Either zero view returns ErrInvalidConfig and no records; other
|
||||||
|
// ConfigKit errors are returned unchanged. An empty diff is not evidence of
|
||||||
|
// equivalent engine behavior or execution. Records can contain ordinary
|
||||||
|
// application data, so callers choose where and to whom to disclose them.
|
||||||
|
func (v ConfigurationInspection) Diff(other ConfigurationInspection) ([]configkit.Difference, error) {
|
||||||
|
if v.source == nil || other.source == nil {
|
||||||
|
return nil, ErrInvalidConfig
|
||||||
|
}
|
||||||
|
return configuration.Diff(v.source, other.source)
|
||||||
|
}
|
||||||
|
|
||||||
// Metadata returns detached effective presence and history records.
|
// Metadata returns detached effective presence and history records.
|
||||||
func (v ConfigurationInspection) Metadata() configkit.Metadata {
|
func (v ConfigurationInspection) Metadata() configkit.Metadata {
|
||||||
if v.source == nil {
|
if v.source == nil {
|
||||||
|
|||||||
@@ -4,6 +4,7 @@ import (
|
|||||||
"bytes"
|
"bytes"
|
||||||
"context"
|
"context"
|
||||||
"errors"
|
"errors"
|
||||||
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
"strings"
|
"strings"
|
||||||
"sync"
|
"sync"
|
||||||
@@ -11,25 +12,34 @@ import (
|
|||||||
"testing"
|
"testing"
|
||||||
"testing/fstest"
|
"testing/fstest"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/ConfigKit"
|
"go.maximumdirect.net/configkit"
|
||||||
"gitea.maximumdirect.net/eric/promptkit"
|
"go.maximumdirect.net/promptkit"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestConfigurationInspectionReportsLiteralKeysAndRedactedHistory(t *testing.T) {
|
func TestConfigurationInspectionReportsLiteralKeysAndRedactedHistory(t *testing.T) {
|
||||||
engine, err := promptkit.NewEngine(promptkit.Config{Sources: promptkit.ConfigurationSources{
|
engine, err := promptkit.NewEngine(promptkit.Config{Sources: promptkit.ConfigurationSources{
|
||||||
Underlays: []configkit.Underlay{
|
Underlays: []configkit.Underlay{
|
||||||
{Inputs: []configkit.Input{{Source: configkit.Mapping("defaults", map[string]any{
|
{Inputs: []configkit.Input{{Source: configkit.Mapping("defaults", map[string]any{
|
||||||
"backends": map[string]any{"local": map[string]any{
|
"backends": []any{map[string]any{
|
||||||
"endpoint": "https://example.invalid/v1", "api_key_env": "OPTIONAL_KEY",
|
"id": "local", "endpoint": "https://example.invalid/v1", "api_key_env": "OPTIONAL_KEY",
|
||||||
"extra_params": map[string]any{"token": "private-sentinel", "visible": "public-value"},
|
"extra_params": map[string]any{"token": "private-sentinel", "visible": "public-value"},
|
||||||
}},
|
}},
|
||||||
"profiles": map[string]any{
|
"collections": map[string]any{"literal": map[string]any{
|
||||||
"base.v1": map[string]any{"backend": "local", "model": "default-model"},
|
"backends": []any{
|
||||||
"literal/id": map[string]any{"extends": "base.v1"},
|
map[string]any{"id": "local", "endpoint": "https://example.invalid/v1", "extra_params": map[string]any{"token": "namespaced-private-sentinel"}},
|
||||||
},
|
map[string]any{"id": "child", "extends": map[string]any{"id": "local"}},
|
||||||
|
},
|
||||||
|
"profiles": []any{
|
||||||
|
map[string]any{"id": "base.v1", "backend": "local", "model": "default-model"},
|
||||||
|
map[string]any{"id": "id", "extends": map[string]any{"id": "base.v1"}},
|
||||||
|
},
|
||||||
|
}},
|
||||||
})}}},
|
})}}},
|
||||||
{Inputs: []configkit.Input{{Source: configkit.Mapping("operator", map[string]any{
|
{Inputs: []configkit.Input{{Source: configkit.Mapping("operator", map[string]any{
|
||||||
"profiles": map[string]any{"base.v1": map[string]any{"model": "operator-model"}},
|
"collections": map[string]any{"literal": map[string]any{
|
||||||
|
"backends": []any{map[string]any{"id": "local", "endpoint": "https://example.invalid/v1", "extra_params": map[string]any{"token": "replacement-private-sentinel"}}},
|
||||||
|
"profiles": []any{map[string]any{"id": "base.v1", "backend": "local", "model": "operator-model"}},
|
||||||
|
}},
|
||||||
})}}},
|
})}}},
|
||||||
},
|
},
|
||||||
}})
|
}})
|
||||||
@@ -40,24 +50,38 @@ func TestConfigurationInspectionReportsLiteralKeysAndRedactedHistory(t *testing.
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("inspect configuration: %v", err)
|
t.Fatalf("inspect configuration: %v", err)
|
||||||
}
|
}
|
||||||
modelPath := configkit.Keys("profiles", "base.v1", "model")
|
modelPath := configkit.Keys("collections", "literal", "profiles").Index(0).Key("model")
|
||||||
model, found := view.Explain(modelPath)
|
model, found := view.Explain(modelPath)
|
||||||
if !found || !strings.Contains(model.Effective.YAML, "operator-model") || len(model.History) < 2 {
|
if !found || !strings.Contains(model.Effective.YAML, "operator-model") || len(model.History) == 0 {
|
||||||
t.Fatalf("layered model explanation = (%+v, %t)", model, found)
|
t.Fatalf("layered model explanation = (%+v, %t)", model, found)
|
||||||
}
|
}
|
||||||
inheritedPath := configkit.Keys("profiles", "literal/id", "model")
|
inheritedPath := configkit.Keys("collections", "literal", "profiles").Index(1).Key("model")
|
||||||
inherited, found := view.Explain(inheritedPath)
|
inherited, found := view.Explain(inheritedPath)
|
||||||
if !found || !strings.Contains(inherited.Effective.YAML, "operator-model") || len(inherited.History) == 0 || !view.Metadata().IsExplicit(inheritedPath) {
|
if !found || !strings.Contains(inherited.Effective.YAML, "operator-model") || len(inherited.History) == 0 || !view.Metadata().IsExplicit(inheritedPath) {
|
||||||
t.Fatalf("literal-key inheritance explanation = (%+v, %t)", inherited, found)
|
t.Fatalf("literal-key inheritance explanation = (%+v, %t)", inherited, found)
|
||||||
}
|
}
|
||||||
if inheritedPath.String() != "/profiles/literal~1id/model" {
|
if inheritedPath.String() != "/collections/literal/profiles/1/model" {
|
||||||
t.Fatalf("literal-key path = %q", inheritedPath)
|
t.Fatalf("literal-key path = %q", inheritedPath)
|
||||||
}
|
}
|
||||||
secretPath := configkit.Keys("backends", "local", "extra_params", "token")
|
secretPath := configkit.Keys("backends").Index(0).Key("extra_params").Key("token")
|
||||||
secret, found := view.Explain(secretPath)
|
secret, found := view.Explain(secretPath)
|
||||||
if !found || !secret.Effective.Redacted || strings.Contains(secret.Effective.YAML, "private-sentinel") {
|
if !found || !secret.Effective.Redacted || strings.Contains(secret.Effective.YAML, "private-sentinel") {
|
||||||
t.Fatalf("credential-shaped provider value was not redacted: (%+v, %t)", secret, found)
|
t.Fatalf("credential-shaped provider value was not redacted: (%+v, %t)", secret, found)
|
||||||
}
|
}
|
||||||
|
namespacedSecretPath := configkit.Keys("collections", "literal", "backends").Index(0).Key("extra_params").Key("token")
|
||||||
|
namespacedSecret, found := view.Explain(namespacedSecretPath)
|
||||||
|
if !found || !namespacedSecret.Effective.Redacted || strings.Contains(namespacedSecret.Effective.YAML, "namespaced-private-sentinel") {
|
||||||
|
t.Fatalf("namespaced provider value was not redacted: (%+v, %t)", namespacedSecret, found)
|
||||||
|
}
|
||||||
|
inheritedSecretPath := configkit.Keys("collections", "literal", "backends").Index(1).Key("extra_params").Key("token")
|
||||||
|
inheritedSecret, found := view.Explain(inheritedSecretPath)
|
||||||
|
if !found || !inheritedSecret.Effective.Redacted || strings.Contains(inheritedSecret.Effective.YAML, "replacement-private-sentinel") {
|
||||||
|
t.Fatalf("inherited provider value was not redacted: (%+v, %t)", inheritedSecret, found)
|
||||||
|
}
|
||||||
|
metadata := fmt.Sprintf("%+v", view.Metadata().History(inheritedSecretPath))
|
||||||
|
if strings.Contains(metadata, "replacement-private-sentinel") || strings.Contains(metadata, "namespaced-private-sentinel") {
|
||||||
|
t.Fatal("metadata disclosed a sensitive provider value")
|
||||||
|
}
|
||||||
var effective bytes.Buffer
|
var effective bytes.Buffer
|
||||||
if err := view.WriteEffective(&effective); err != nil {
|
if err := view.WriteEffective(&effective); err != nil {
|
||||||
t.Fatalf("write effective configuration: %v", err)
|
t.Fatalf("write effective configuration: %v", err)
|
||||||
@@ -66,7 +90,7 @@ func TestConfigurationInspectionReportsLiteralKeysAndRedactedHistory(t *testing.
|
|||||||
t.Fatalf("unexpected effective report: %s", effective.String())
|
t.Fatalf("unexpected effective report: %s", effective.String())
|
||||||
}
|
}
|
||||||
var explanation bytes.Buffer
|
var explanation bytes.Buffer
|
||||||
if err := view.WriteExplanation(&explanation, secretPath); err != nil || strings.Contains(explanation.String(), "private-sentinel") {
|
if err := view.WriteExplanation(&explanation, namespacedSecretPath); err != nil || strings.Contains(explanation.String(), "namespaced-private-sentinel") {
|
||||||
t.Fatalf("secret explanation = (%q, %v)", explanation.String(), err)
|
t.Fatalf("secret explanation = (%q, %v)", explanation.String(), err)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -93,6 +117,45 @@ func TestConfigurationInspectionReportsLiteralKeysAndRedactedHistory(t *testing.
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestConfigurationInspectionFailureDoesNotDiscloseSensitiveValues(t *testing.T) {
|
||||||
|
_, err := promptkit.NewEngine(promptkit.Config{Sources: promptkit.ConfigurationSources{Main: &configkit.Input{
|
||||||
|
Source: configkit.Mapping("invalid backend", map[string]any{
|
||||||
|
"collections": map[string]any{"private": map[string]any{"backends": []any{
|
||||||
|
map[string]any{"id": "backend", "endpoint": "invalid endpoint", "extra_params": map[string]any{"token": "failure-private-sentinel"}},
|
||||||
|
}}},
|
||||||
|
}),
|
||||||
|
}}})
|
||||||
|
var loadErr *configkit.LoadError
|
||||||
|
if !errors.As(err, &loadErr) {
|
||||||
|
t.Fatalf("invalid backend error = %v, want load error", err)
|
||||||
|
}
|
||||||
|
if text := fmt.Sprintf("%v %+v", err, loadErr.Diagnostics()); strings.Contains(text, "failure-private-sentinel") {
|
||||||
|
t.Fatalf("failure diagnostics disclosed a sensitive value: %s", text)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestConfigurationInspectionRetainsMainSpecificationDeclaration(t *testing.T) {
|
||||||
|
engine, err := promptkit.NewEngine(promptkit.Config{Sources: promptkit.ConfigurationSources{Main: &configkit.Input{
|
||||||
|
Source: configkit.Mapping("main", map[string]any{"version": "2"}),
|
||||||
|
}}})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("construct engine with accepted declaration: %v", err)
|
||||||
|
}
|
||||||
|
inspection, err := engine.InspectConfiguration()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("inspect configuration: %v", err)
|
||||||
|
}
|
||||||
|
path := configkit.Keys("version")
|
||||||
|
field, found := inspection.Explain(path)
|
||||||
|
if !found || !inspection.Metadata().IsExplicit(path) || !strings.Contains(field.Effective.YAML, "2") {
|
||||||
|
t.Fatalf("main specification declaration was not retained: (%+v, %t)", field, found)
|
||||||
|
}
|
||||||
|
var effective bytes.Buffer
|
||||||
|
if err := inspection.WriteEffective(&effective); err != nil || !strings.Contains(effective.String(), "version") {
|
||||||
|
t.Fatalf("effective inspection = (%q, %v), want retained version", effective.String(), err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
type failingInspectionWriter struct{ err error }
|
type failingInspectionWriter struct{ err error }
|
||||||
|
|
||||||
func (writer failingInspectionWriter) Write([]byte) (int, error) { return 0, writer.err }
|
func (writer failingInspectionWriter) Write([]byte) (int, error) { return 0, writer.err }
|
||||||
@@ -117,7 +180,12 @@ func TestConfigurationInspectionZeroAndWriterErrors(t *testing.T) {
|
|||||||
t.Fatalf("zero explanation writer = %v", err)
|
t.Fatalf("zero explanation writer = %v", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
valid, err := promptkit.NewEngine(promptkit.Config{})
|
profile := configkit.Input{Source: configkit.Mapping("inspection test profile", map[string]any{
|
||||||
|
"profiles": []any{map[string]any{"id": "inspection-profile", "endpoint": "https://configured.example/v1", "model": "configured-model"}},
|
||||||
|
})}
|
||||||
|
valid, err := promptkit.NewEngine(promptkit.Config{Sources: promptkit.ConfigurationSources{
|
||||||
|
Underlays: []configkit.Underlay{{Inputs: []configkit.Input{profile}}},
|
||||||
|
}})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("construct engine: %v", err)
|
t.Fatalf("construct engine: %v", err)
|
||||||
}
|
}
|
||||||
@@ -130,61 +198,109 @@ func TestConfigurationInspectionZeroAndWriterErrors(t *testing.T) {
|
|||||||
if err := view.WriteEffective(writer); !errors.Is(err, writeErr) {
|
if err := view.WriteEffective(writer); !errors.Is(err, writeErr) {
|
||||||
t.Fatalf("effective writer error = %v", err)
|
t.Fatalf("effective writer error = %v", err)
|
||||||
}
|
}
|
||||||
if err := view.WriteExplanation(writer, configkit.Keys("profiles", "mistral-small-3", "model")); !errors.Is(err, writeErr) {
|
if err := view.WriteExplanation(writer, configkit.Keys("profiles").Index(0).Key("model")); !errors.Is(err, writeErr) {
|
||||||
t.Fatalf("explanation writer error = %v", err)
|
t.Fatalf("explanation writer error = %v", err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestConfigurationInspectionUsesCapturedSourcesWithoutProviderCalls(t *testing.T) {
|
func TestConfigurationInspectionUsesCapturedSourcesWithoutProviderCalls(t *testing.T) {
|
||||||
|
const promptDocument = "prompts:\n - id: captured\n default_profile: offline\n messages:\n - role: user\n content_file: body.tmpl\n output:\n format: text\n validation_mode: none\n"
|
||||||
source := &unreadableAfterConstructionFS{FS: fstest.MapFS{
|
source := &unreadableAfterConstructionFS{FS: fstest.MapFS{
|
||||||
"config/prompt.yaml": &fstest.MapFile{Data: []byte(capturedPromptDocument)},
|
"config/prompt.yaml": &fstest.MapFile{Data: []byte(promptDocument)},
|
||||||
"config/body.tmpl": &fstest.MapFile{Data: []byte("hello")},
|
"config/body.tmpl": &fstest.MapFile{Data: []byte("hello")},
|
||||||
}}
|
}}
|
||||||
inputs, err := promptkit.FilesystemInputs("inspection source", source, "config")
|
inputs, err := promptkit.FilesystemInputs("inspection source", source, "config")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("select inputs: %v", err)
|
t.Fatalf("select inputs: %v", err)
|
||||||
}
|
}
|
||||||
|
otherSource := &unreadableAfterConstructionFS{FS: fstest.MapFS{
|
||||||
|
"config/prompt.yaml": &fstest.MapFile{Data: []byte(promptDocument)},
|
||||||
|
"config/body.tmpl": &fstest.MapFile{Data: []byte("hello")},
|
||||||
|
}}
|
||||||
|
otherInputs, err := promptkit.FilesystemInputs("comparison source", otherSource, "config")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("select comparison inputs: %v", err)
|
||||||
|
}
|
||||||
var modelCalls atomic.Int64
|
var modelCalls atomic.Int64
|
||||||
client := countingLLMClient{calls: &modelCalls}
|
client := countingLLMClient{calls: &modelCalls}
|
||||||
endpoint, model := "https://example.invalid/v1", "offline-model"
|
endpoint, model, otherModel := "https://example.invalid/v1", "offline-model", "comparison-model"
|
||||||
engine, err := promptkit.NewEngine(promptkit.Config{Sources: promptkit.ConfigurationSources{
|
engine, err := promptkit.NewEngine(promptkit.Config{Sources: promptkit.ConfigurationSources{
|
||||||
Underlays: []configkit.Underlay{{Inputs: inputs}, {Inputs: []configkit.Input{{Source: promptkit.ProfileSource("offline profile", map[string]promptkit.ProfileConfig{
|
Underlays: []configkit.Underlay{{Inputs: inputs}, {Inputs: []configkit.Input{{Source: configkit.Mapping("offline profile", map[string]any{
|
||||||
"offline": {Endpoint: &endpoint, Model: &model},
|
"profiles": []any{map[string]any{"id": "offline", "endpoint": endpoint, "model": model}},
|
||||||
})}}}},
|
})}}}},
|
||||||
}}, promptkit.WithLLMClient(client))
|
}}, promptkit.WithLLMClient(client))
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("construct engine: %v", err)
|
t.Fatalf("construct engine: %v", err)
|
||||||
}
|
}
|
||||||
|
otherEngine, err := promptkit.NewEngine(promptkit.Config{Sources: promptkit.ConfigurationSources{
|
||||||
|
Underlays: []configkit.Underlay{{Inputs: otherInputs}, {Inputs: []configkit.Input{{Source: configkit.Mapping("comparison profile", map[string]any{
|
||||||
|
"profiles": []any{map[string]any{"id": "offline", "endpoint": endpoint, "model": otherModel}},
|
||||||
|
})}}}},
|
||||||
|
}}, promptkit.WithLLMClient(client))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("construct comparison engine: %v", err)
|
||||||
|
}
|
||||||
source.closed.Store(true)
|
source.closed.Store(true)
|
||||||
|
otherSource.closed.Store(true)
|
||||||
view, err := engine.InspectConfiguration()
|
view, err := engine.InspectConfiguration()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("inspect configuration: %v", err)
|
t.Fatalf("inspect configuration: %v", err)
|
||||||
}
|
}
|
||||||
if _, found := view.Explain(configkit.Keys("prompts", "captured", "1", "messages").Index(0).Key("content_file")); !found {
|
otherView, err := otherEngine.InspectConfiguration()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("inspect comparison configuration: %v", err)
|
||||||
|
}
|
||||||
|
var expected configkit.Difference
|
||||||
|
for index := 0; index < 3; index++ {
|
||||||
|
differences, err := view.Diff(otherView)
|
||||||
|
if err != nil || len(differences) != 1 {
|
||||||
|
t.Fatalf("compare captured configurations = (%+v, %v), want one difference", differences, err)
|
||||||
|
}
|
||||||
|
if differences[0].Path.String() != "/profiles" ||
|
||||||
|
!strings.Contains(differences[0].Left.YAML, model) ||
|
||||||
|
!strings.Contains(differences[0].Right.YAML, otherModel) {
|
||||||
|
t.Fatalf("captured difference = %+v", differences[0])
|
||||||
|
}
|
||||||
|
if index == 0 {
|
||||||
|
expected = differences[0]
|
||||||
|
} else if differences[0].Path.String() != expected.Path.String() ||
|
||||||
|
differences[0].Left.YAML != expected.Left.YAML || differences[0].Right.YAML != expected.Right.YAML {
|
||||||
|
t.Fatalf("captured difference changed between reads: first=%+v next=%+v", expected, differences[0])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if _, found := view.Explain(configkit.Keys("prompts").Index(0).Key("messages").Index(0).Key("content_file")); !found {
|
||||||
t.Fatal("captured prompt content path was not inspectable")
|
t.Fatal("captured prompt content path was not inspectable")
|
||||||
}
|
}
|
||||||
var report bytes.Buffer
|
var report bytes.Buffer
|
||||||
if err := view.WriteEffective(&report); err != nil || !strings.Contains(report.String(), "captured") {
|
if err := view.WriteEffective(&report); err != nil || !strings.Contains(report.String(), "captured") {
|
||||||
t.Fatalf("write captured report = (%q, %v)", report.String(), err)
|
t.Fatalf("write captured report = (%q, %v)", report.String(), err)
|
||||||
}
|
}
|
||||||
if source.reads.Load() != 0 || modelCalls.Load() != 0 {
|
if source.reads.Load() != 0 || otherSource.reads.Load() != 0 || modelCalls.Load() != 0 {
|
||||||
t.Fatalf("inspection touched source or provider: reads=%d requests=%d", source.reads.Load(), modelCalls.Load())
|
t.Fatalf("inspection or comparison touched source or provider: reads=(%d,%d) requests=%d", source.reads.Load(), otherSource.reads.Load(), modelCalls.Load())
|
||||||
}
|
}
|
||||||
|
|
||||||
const calls = 16
|
const calls = 24
|
||||||
var wait sync.WaitGroup
|
var wait sync.WaitGroup
|
||||||
errs := make(chan error, calls)
|
errs := make(chan error, calls)
|
||||||
for index := 0; index < calls; index++ {
|
for index := 0; index < calls; index++ {
|
||||||
wait.Add(1)
|
wait.Add(1)
|
||||||
go func(index int) {
|
go func(index int) {
|
||||||
defer wait.Done()
|
defer wait.Done()
|
||||||
if index%2 == 0 {
|
switch index % 3 {
|
||||||
|
case 0:
|
||||||
_, err := engine.InspectConfiguration()
|
_, err := engine.InspectConfiguration()
|
||||||
errs <- err
|
errs <- err
|
||||||
return
|
case 1:
|
||||||
|
_, err := engine.Run(context.Background(), promptkit.RunRequest{PromptID: "captured", SessionID: "direct"})
|
||||||
|
errs <- err
|
||||||
|
case 2:
|
||||||
|
differences, err := view.Diff(otherView)
|
||||||
|
if err == nil && (len(differences) != 1 || differences[0].Path.String() != expected.Path.String() ||
|
||||||
|
differences[0].Left.YAML != expected.Left.YAML || differences[0].Right.YAML != expected.Right.YAML) {
|
||||||
|
err = errors.New("concurrent comparison returned an unexpected difference")
|
||||||
|
}
|
||||||
|
errs <- err
|
||||||
}
|
}
|
||||||
_, err := engine.Run(context.Background(), promptkit.RunRequest{PromptID: "captured", SessionID: "direct"})
|
|
||||||
errs <- err
|
|
||||||
}(index)
|
}(index)
|
||||||
}
|
}
|
||||||
wait.Wait()
|
wait.Wait()
|
||||||
@@ -194,7 +310,7 @@ func TestConfigurationInspectionUsesCapturedSourcesWithoutProviderCalls(t *testi
|
|||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
if source.reads.Load() != 0 || modelCalls.Load() != calls/2 {
|
if source.reads.Load() != 0 || otherSource.reads.Load() != 0 || modelCalls.Load() != calls/3 {
|
||||||
t.Fatalf("concurrent inspection/execution = source reads %d, model calls %d", source.reads.Load(), modelCalls.Load())
|
t.Fatalf("concurrent inspection/comparison/execution = source reads (%d,%d), model calls %d", source.reads.Load(), otherSource.reads.Load(), modelCalls.Load())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -7,10 +7,27 @@ import (
|
|||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/ConfigKit"
|
"go.maximumdirect.net/configkit"
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/filecatalog"
|
"go.maximumdirect.net/promptkit/internal/domain"
|
||||||
|
"go.maximumdirect.net/promptkit/internal/filecatalog"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// CollectionInput mounts source at the selected collection's configuration
|
||||||
|
// destination, collections/<namespace>, and enables ConfigKit imports for that
|
||||||
|
// input. An invalid namespace returns an error matching ErrInvalidConfig. The
|
||||||
|
// source is not read or validated until ConfigKit loads it. Callers may adjust
|
||||||
|
// the returned input, including its filesystem context or imports setting.
|
||||||
|
func CollectionInput(namespace string, source configkit.Source) (configkit.Input, error) {
|
||||||
|
if !domain.IsValidResourceNamespace(namespace) {
|
||||||
|
return configkit.Input{}, fmt.Errorf("%w: invalid collection namespace %q", ErrInvalidConfig, namespace)
|
||||||
|
}
|
||||||
|
return configkit.Input{
|
||||||
|
Source: source,
|
||||||
|
Destination: configkit.Keys("collections", namespace),
|
||||||
|
Imports: true,
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
// DirectoryInputs selects the YAML files beneath an explicitly chosen host
|
// DirectoryInputs selects the YAML files beneath an explicitly chosen host
|
||||||
// directory as one strict-composition group. The returned order is deterministic;
|
// directory as one strict-composition group. The returned order is deterministic;
|
||||||
// it does not assign precedence among those files. Discovery is recursive over
|
// it does not assign precedence among those files. Discovery is recursive over
|
||||||
|
|||||||
@@ -1,14 +1,16 @@
|
|||||||
package promptkit_test
|
package promptkit_test
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
"io/fs"
|
"io/fs"
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"testing"
|
"testing"
|
||||||
"testing/fstest"
|
"testing/fstest"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/ConfigKit"
|
"go.maximumdirect.net/configkit"
|
||||||
"gitea.maximumdirect.net/eric/promptkit"
|
"go.maximumdirect.net/promptkit"
|
||||||
)
|
)
|
||||||
|
|
||||||
type sourceDocument struct {
|
type sourceDocument struct {
|
||||||
@@ -16,6 +18,78 @@ type sourceDocument struct {
|
|||||||
Second string `yaml:"second"`
|
Second string `yaml:"second"`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestCollectionInputValidatesWithoutReadingSource(t *testing.T) {
|
||||||
|
input, err := promptkit.CollectionInput("docs", configkit.File(filepath.Join(t.TempDir(), "not-read.yaml")))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if input.Destination.String() != "/collections/docs" || !input.Imports {
|
||||||
|
t.Fatalf("collection input = %+v, want destination /collections/docs with imports enabled", input)
|
||||||
|
}
|
||||||
|
for _, namespace := range []string{"", " ", "docs/api"} {
|
||||||
|
if _, err := promptkit.CollectionInput(namespace, configkit.NoSource()); !errors.Is(err, promptkit.ErrInvalidConfig) {
|
||||||
|
t.Errorf("namespace %q error = %v, want ErrInvalidConfig", namespace, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCollectionInputLoadsNativeImportsAndLaterOverride(t *testing.T) {
|
||||||
|
directory := t.TempDir()
|
||||||
|
mainPath := filepath.Join(directory, "collection.yaml")
|
||||||
|
defaultsPath := filepath.Join(directory, "defaults.yaml")
|
||||||
|
if err := os.WriteFile(mainPath, []byte("config:\n imports:\n - path: defaults.yaml\n required: true\n"), 0o600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := os.WriteFile(defaultsPath, []byte("prompts:\n - id: greeting\n messages:\n - role: user\n content: Hello\n output:\n format: text\n validation_mode: none\n"), 0o600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
input, err := promptkit.CollectionInput("docs", configkit.File(mainPath))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
engine, err := promptkit.NewEngine(promptkit.Config{Sources: promptkit.ConfigurationSources{
|
||||||
|
Underlays: []configkit.Underlay{{Inputs: []configkit.Input{input}}},
|
||||||
|
Main: &configkit.Input{
|
||||||
|
Source: configkit.Mapping("later collection override", map[string]any{"prompts": []any{map[string]any{"id": "greeting", "inputs": []any{map[string]any{"name": "overridden"}}, "messages": []any{map[string]any{"role": "user", "content": "Updated"}}, "output": map[string]any{"format": "text", "validation_mode": "none"}}}}),
|
||||||
|
Destination: configkit.Keys("collections", "docs"),
|
||||||
|
},
|
||||||
|
}})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("construct engine with native collection import: %v", err)
|
||||||
|
}
|
||||||
|
inspection, err := engine.InspectPrompt(context.Background(), "docs/greeting")
|
||||||
|
if err != nil || inspection.PromptID != "docs/greeting" || len(inspection.Inputs) != 1 || inspection.Inputs[0].Name != "overridden" {
|
||||||
|
t.Fatalf("inspect imported and overlaid prompt = (%+v, %v)", inspection, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCollectionInputLoadsEmbeddedImportsAndLaterOverride(t *testing.T) {
|
||||||
|
files := fstest.MapFS{
|
||||||
|
"collection.yaml": {Data: []byte("config:\n imports:\n - path: defaults.yaml\n required: true\n")},
|
||||||
|
"defaults.yaml": {Data: []byte("prompts:\n - id: greeting\n messages:\n - role: user\n content: Hello\n output:\n format: text\n validation_mode: none\n")},
|
||||||
|
}
|
||||||
|
filesystem := configkit.NewFilesystem("embedded collection", files)
|
||||||
|
input, err := promptkit.CollectionInput("docs", filesystem.File("collection.yaml"))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
input.Filesystem = &configkit.FilesystemContext{FS: &filesystem, Root: "."}
|
||||||
|
engine, err := promptkit.NewEngine(promptkit.Config{Sources: promptkit.ConfigurationSources{
|
||||||
|
Underlays: []configkit.Underlay{{Inputs: []configkit.Input{input}}},
|
||||||
|
Main: &configkit.Input{
|
||||||
|
Source: configkit.Mapping("later collection override", map[string]any{"prompts": []any{map[string]any{"id": "greeting", "inputs": []any{map[string]any{"name": "overridden"}}, "messages": []any{map[string]any{"role": "user", "content": "Updated"}}, "output": map[string]any{"format": "text", "validation_mode": "none"}}}}),
|
||||||
|
Destination: configkit.Keys("collections", "docs"),
|
||||||
|
},
|
||||||
|
}})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("construct engine with embedded collection import: %v", err)
|
||||||
|
}
|
||||||
|
inspection, err := engine.InspectPrompt(context.Background(), "docs/greeting")
|
||||||
|
if err != nil || inspection.PromptID != "docs/greeting" || len(inspection.Inputs) != 1 || inspection.Inputs[0].Name != "overridden" {
|
||||||
|
t.Fatalf("inspect imported and overlaid prompt = (%+v, %v)", inspection, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestDirectoryInputsSelectsSortedFilesWithRootContext(t *testing.T) {
|
func TestDirectoryInputsSelectsSortedFilesWithRootContext(t *testing.T) {
|
||||||
root := t.TempDir()
|
root := t.TempDir()
|
||||||
if err := os.Mkdir(filepath.Join(root, "nested"), 0o755); err != nil {
|
if err := os.Mkdir(filepath.Join(root, "nested"), 0o755); err != nil {
|
||||||
|
|||||||
@@ -1,6 +1,7 @@
|
|||||||
package promptkit_test
|
package promptkit_test
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"bytes"
|
||||||
"context"
|
"context"
|
||||||
"errors"
|
"errors"
|
||||||
"io"
|
"io"
|
||||||
@@ -11,8 +12,8 @@ import (
|
|||||||
"testing"
|
"testing"
|
||||||
"testing/fstest"
|
"testing/fstest"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/ConfigKit"
|
"go.maximumdirect.net/configkit"
|
||||||
"gitea.maximumdirect.net/eric/promptkit"
|
"go.maximumdirect.net/promptkit"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestProfileEnvironmentLookupAcceptsNonShellNames(t *testing.T) {
|
func TestProfileEnvironmentLookupAcceptsNonShellNames(t *testing.T) {
|
||||||
@@ -37,18 +38,19 @@ func TestProfileEnvironmentLookupAcceptsNonShellNames(t *testing.T) {
|
|||||||
}
|
}
|
||||||
cfg := simpleConfig("hello")
|
cfg := simpleConfig("hello")
|
||||||
cfg.Sources.Underlays = []configkit.Underlay{{Inputs: []configkit.Input{*cfg.Sources.Main}}}
|
cfg.Sources.Underlays = []configkit.Underlay{{Inputs: []configkit.Input{*cfg.Sources.Main}}}
|
||||||
|
endpoint, model := "http://example.test/v1", "model"
|
||||||
lowerName := name
|
lowerName := name
|
||||||
cfg.Sources.Underlays = append(cfg.Sources.Underlays, configkit.Underlay{Inputs: []configkit.Input{{
|
cfg.Sources.Underlays = append(cfg.Sources.Underlays, configkit.Underlay{Inputs: []configkit.Input{{
|
||||||
Source: promptkit.ProfileSource("default credentials", map[string]promptkit.ProfileConfig{
|
Source: promptkit.ProfileSource("default credentials", []promptkit.ProfileConfig{
|
||||||
"profile": {APIKeyEnv: &lowerName},
|
{ID: "profile", Endpoint: &endpoint, Model: &model, APIKeyEnv: &lowerName},
|
||||||
}),
|
}),
|
||||||
}}})
|
}}})
|
||||||
env := " " + name + " "
|
env := " " + name + " "
|
||||||
if test.clear {
|
if test.clear {
|
||||||
env = ""
|
env = ""
|
||||||
}
|
}
|
||||||
cfg.Sources.Main = &configkit.Input{Source: promptkit.ProfileSource("credentials", map[string]promptkit.ProfileConfig{
|
cfg.Sources.Main = &configkit.Input{Source: promptkit.ProfileSource("credentials", []promptkit.ProfileConfig{
|
||||||
"profile": {APIKeyEnv: &env},
|
{ID: "profile", Endpoint: &endpoint, Model: &model, APIKeyEnv: &env},
|
||||||
})}
|
})}
|
||||||
var calls int
|
var calls int
|
||||||
var auth string
|
var auth string
|
||||||
@@ -72,20 +74,23 @@ func TestProfileEnvironmentLookupAcceptsNonShellNames(t *testing.T) {
|
|||||||
func TestPublicConstructionWithLocalBackendAndProgrammaticProfile(t *testing.T) {
|
func TestPublicConstructionWithLocalBackendAndProgrammaticProfile(t *testing.T) {
|
||||||
backendID, model := "workstation", "offline-model"
|
backendID, model := "workstation", "offline-model"
|
||||||
prompt := configkit.Input{Source: configkit.Mapping("prompt", map[string]any{
|
prompt := configkit.Input{Source: configkit.Mapping("prompt", map[string]any{
|
||||||
"prompts": map[string]any{"hello": map[string]any{"1": map[string]any{
|
"prompts": []any{map[string]any{
|
||||||
|
"id": "hello",
|
||||||
"default_profile": "offline",
|
"default_profile": "offline",
|
||||||
"messages": []any{map[string]any{"role": "user", "content": "Hello"}},
|
"messages": []any{map[string]any{"role": "user", "content": "Hello"}},
|
||||||
"output": map[string]any{"format": "text", "validation_mode": "none"},
|
"output": map[string]any{"format": "text", "validation_mode": "none"},
|
||||||
}}},
|
}},
|
||||||
})}
|
})}
|
||||||
client := &fakeLLMClient{response: &promptkit.GenerateResponse{Content: "reply"}}
|
client := &fakeLLMClient{response: &promptkit.GenerateResponse{Content: "reply"}}
|
||||||
|
localBackend := promptkit.LocalBackend("http://localhost:8000/v1", 2)
|
||||||
|
localBackend.ID = backendID
|
||||||
engine, err := promptkit.NewEngine(promptkit.Config{Sources: promptkit.ConfigurationSources{
|
engine, err := promptkit.NewEngine(promptkit.Config{Sources: promptkit.ConfigurationSources{
|
||||||
Underlays: []configkit.Underlay{{Inputs: []configkit.Input{
|
Underlays: []configkit.Underlay{{Inputs: []configkit.Input{
|
||||||
{Source: promptkit.BackendSource("local backend", map[string]promptkit.BackendConfig{
|
{Source: promptkit.BackendSource("local backend", []promptkit.BackendConfig{
|
||||||
backendID: promptkit.LocalBackend("http://localhost:8000/v1", 2),
|
localBackend,
|
||||||
})},
|
})},
|
||||||
{Source: promptkit.ProfileSource("profile", map[string]promptkit.ProfileConfig{
|
{Source: promptkit.ProfileSource("profile", []promptkit.ProfileConfig{
|
||||||
"offline": {Backend: &backendID, Model: &model},
|
{ID: "offline", Backend: &backendID, Model: &model},
|
||||||
})},
|
})},
|
||||||
}}},
|
}}},
|
||||||
Main: &prompt,
|
Main: &prompt,
|
||||||
@@ -105,39 +110,68 @@ func TestPublicConstructionWithLocalBackendAndProgrammaticProfile(t *testing.T)
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestFormerCatalogBackendIDsWorkWhenConfigured(t *testing.T) {
|
||||||
|
openRouterID, rakestrawhomeID := promptkit.BackendOpenRouter, promptkit.BackendRakestrawHome
|
||||||
|
openRouterEndpoint, rakestrawhomeEndpoint := "https://openrouter.example/v1", "https://inference.example/v1"
|
||||||
|
model := "configured-model"
|
||||||
|
engine, err := promptkit.NewEngine(promptkit.Config{Sources: promptkit.ConfigurationSources{
|
||||||
|
Underlays: []configkit.Underlay{{Inputs: []configkit.Input{
|
||||||
|
{Source: promptkit.BackendSource("application backends", []promptkit.BackendConfig{
|
||||||
|
{ID: openRouterID, Endpoint: &openRouterEndpoint},
|
||||||
|
{ID: rakestrawhomeID, Endpoint: &rakestrawhomeEndpoint},
|
||||||
|
})},
|
||||||
|
{Source: promptkit.ProfileSource("application profiles", []promptkit.ProfileConfig{
|
||||||
|
{ID: "openrouter-profile", Backend: &openRouterID, Model: &model},
|
||||||
|
{ID: "rakestrawhome-profile", Backend: &rakestrawhomeID, Model: &model},
|
||||||
|
})},
|
||||||
|
}}},
|
||||||
|
}})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("construct engine with explicitly configured provider IDs: %v", err)
|
||||||
|
}
|
||||||
|
for profileID, backendID := range map[string]string{
|
||||||
|
"openrouter-profile": openRouterID,
|
||||||
|
"rakestrawhome-profile": rakestrawhomeID,
|
||||||
|
} {
|
||||||
|
inspection, err := engine.InspectProfile(context.Background(), profileID)
|
||||||
|
if err != nil || inspection.EffectiveModelParams.BackendID != backendID {
|
||||||
|
t.Fatalf("inspect %q = (%+v, %v), want backend %q", profileID, inspection, err, backendID)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestPublicConstructionCombinesEmbeddedOperatorAndProgrammaticInputs(t *testing.T) {
|
func TestPublicConstructionCombinesEmbeddedOperatorAndProgrammaticInputs(t *testing.T) {
|
||||||
embedded, err := promptkit.FilesystemInputs("embedded defaults", fstest.MapFS{
|
embedded, err := promptkit.FilesystemInputs("embedded defaults", fstest.MapFS{
|
||||||
"config/default.yaml": &fstest.MapFile{Data: []byte(`
|
"config/default.yaml": &fstest.MapFile{Data: []byte(`
|
||||||
profiles:
|
profiles:
|
||||||
application:
|
- id: application
|
||||||
endpoint: https://example.invalid/v1
|
endpoint: https://example.invalid/v1
|
||||||
model: default-model
|
model: default-model
|
||||||
prompts:
|
prompts:
|
||||||
hello:
|
- id: hello
|
||||||
"1":
|
default_profile: application
|
||||||
default_profile: application
|
messages:
|
||||||
messages:
|
- role: user
|
||||||
- role: user
|
content: Hello
|
||||||
content: Hello
|
output:
|
||||||
output:
|
format: text
|
||||||
format: text
|
validation_mode: none
|
||||||
validation_mode: none
|
|
||||||
`)},
|
`)},
|
||||||
}, "config")
|
}, "config")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("select embedded defaults: %v", err)
|
t.Fatalf("select embedded defaults: %v", err)
|
||||||
}
|
}
|
||||||
operatorDirectory := t.TempDir()
|
operatorDirectory := t.TempDir()
|
||||||
if err := os.WriteFile(filepath.Join(operatorDirectory, "override.yaml"), []byte("profiles:\n application:\n model: operator-model\n"), 0o644); err != nil {
|
if err := os.WriteFile(filepath.Join(operatorDirectory, "override.yaml"), []byte("profiles:\n - id: application\n endpoint: https://example.invalid/v1\n model: operator-model\n"), 0o644); err != nil {
|
||||||
t.Fatalf("write operator input: %v", err)
|
t.Fatalf("write operator input: %v", err)
|
||||||
}
|
}
|
||||||
operator, err := promptkit.DirectoryInputs(operatorDirectory)
|
operator, err := promptkit.DirectoryInputs(operatorDirectory)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("select operator inputs: %v", err)
|
t.Fatalf("select operator inputs: %v", err)
|
||||||
}
|
}
|
||||||
programmaticModel := "programmatic-model"
|
programmaticModel, programmaticEndpoint := "programmatic-model", "https://example.invalid/v1"
|
||||||
programmatic := configkit.Input{Source: promptkit.ProfileSource("programmatic settings", map[string]promptkit.ProfileConfig{
|
programmatic := configkit.Input{Source: promptkit.ProfileSource("programmatic settings", []promptkit.ProfileConfig{
|
||||||
"application": {Model: &programmaticModel},
|
{ID: "application", Endpoint: &programmaticEndpoint, Model: &programmaticModel},
|
||||||
})}
|
})}
|
||||||
for _, test := range []struct {
|
for _, test := range []struct {
|
||||||
name string
|
name string
|
||||||
@@ -173,7 +207,7 @@ prompts:
|
|||||||
|
|
||||||
func TestPublicConstructionPreservesConfigKitLoadError(t *testing.T) {
|
func TestPublicConstructionPreservesConfigKitLoadError(t *testing.T) {
|
||||||
engine, err := promptkit.NewEngine(promptkit.Config{Sources: promptkit.ConfigurationSources{Main: &configkit.Input{
|
engine, err := promptkit.NewEngine(promptkit.Config{Sources: promptkit.ConfigurationSources{Main: &configkit.Input{
|
||||||
Source: configkit.Mapping("invalid", map[string]any{"profiles": map[string]any{"broken": map[string]any{"unknown": true}}}),
|
Source: configkit.Mapping("invalid", map[string]any{"profiles": []any{map[string]any{"id": "broken", "unknown": true}}}),
|
||||||
}}})
|
}}})
|
||||||
var loadErr *configkit.LoadError
|
var loadErr *configkit.LoadError
|
||||||
if engine != nil || !errors.Is(err, promptkit.ErrInvalidConfig) || !errors.As(err, &loadErr) {
|
if engine != nil || !errors.Is(err, promptkit.ErrInvalidConfig) || !errors.As(err, &loadErr) {
|
||||||
@@ -189,43 +223,95 @@ func TestPublicConstructionRejectsSuppliedInvalidMainInput(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestPublicConstructionCanOverlayMaintainedBackend(t *testing.T) {
|
func TestPublicConstructionUsesProgrammaticBackendAndProfileSources(t *testing.T) {
|
||||||
endpoint := "http://local-openrouter.example/v1"
|
endpoint, backendID, model := "http://application.example/v1", "application-backend", "synthetic-model"
|
||||||
engine, err := promptkit.NewEngine(promptkit.Config{Sources: promptkit.ConfigurationSources{
|
engine, err := promptkit.NewEngine(promptkit.Config{Sources: promptkit.ConfigurationSources{
|
||||||
Underlays: []configkit.Underlay{{Inputs: []configkit.Input{{Source: promptkit.BackendSource("operator backend", map[string]promptkit.BackendConfig{
|
Underlays: []configkit.Underlay{{Inputs: []configkit.Input{
|
||||||
promptkit.BackendOpenRouter: {Endpoint: &endpoint},
|
{Source: promptkit.BackendSource("operator backend", []promptkit.BackendConfig{
|
||||||
})}}}},
|
{ID: backendID, Endpoint: &endpoint},
|
||||||
|
})},
|
||||||
|
{Source: promptkit.ProfileSource("operator profile", []promptkit.ProfileConfig{
|
||||||
|
{ID: "application-profile", Backend: &backendID, Model: &model},
|
||||||
|
})},
|
||||||
|
}}},
|
||||||
}})
|
}})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("construct engine with backend overlay: %v", err)
|
t.Fatalf("construct engine with backend overlay: %v", err)
|
||||||
}
|
}
|
||||||
inspection, err := engine.InspectProfile(context.Background(), "mistral-small-3")
|
inspection, err := engine.InspectProfile(context.Background(), "application-profile")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("inspect catalog profile: %v", err)
|
t.Fatalf("inspect configured profile: %v", err)
|
||||||
}
|
}
|
||||||
if inspection.EffectiveModelParams.Endpoint != endpoint {
|
if inspection.EffectiveModelParams.Endpoint != endpoint {
|
||||||
t.Fatalf("effective endpoint = %q, want %q", inspection.EffectiveModelParams.Endpoint, endpoint)
|
t.Fatalf("effective endpoint = %q, want %q", inspection.EffectiveModelParams.Endpoint, endpoint)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestPreparationRejectsAmbiguousPromptVersion(t *testing.T) {
|
func TestBackendSourceOwnsSmokeTestValuesAndDefersDefaultLookup(t *testing.T) {
|
||||||
definition := func(content string) map[string]any {
|
backendEndpoint := "https://backend.example/v1"
|
||||||
return map[string]any{
|
defaultProfile := "not-yet-listed"
|
||||||
"messages": []any{map[string]any{"role": "user", "content": content}},
|
reachabilityEndpoint := " https://probe.example/ready?check=1 "
|
||||||
"output": map[string]any{"format": "text", "validation_mode": "none"},
|
authenticationKind := " OPENROUTER_KEY "
|
||||||
}
|
authenticationEndpoint := "https://probe.example/key?scope=current"
|
||||||
}
|
source := promptkit.BackendSource("diagnostic backend", []promptkit.BackendConfig{
|
||||||
|
{
|
||||||
|
ID: "local",
|
||||||
|
Endpoint: &backendEndpoint,
|
||||||
|
SmokeTests: &promptkit.BackendSmokeTestConfig{
|
||||||
|
DefaultProfile: &defaultProfile,
|
||||||
|
Reachability: &promptkit.ReachabilityProbeConfig{Endpoint: &reachabilityEndpoint},
|
||||||
|
Authentication: &promptkit.AuthenticationProbeConfig{
|
||||||
|
Kind: &authenticationKind, Endpoint: &authenticationEndpoint,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
})
|
||||||
|
backendEndpoint = "https://mutated.example/v1"
|
||||||
|
defaultProfile = "mutated-profile"
|
||||||
|
reachabilityEndpoint = "https://mutated.example/ready"
|
||||||
|
authenticationKind = "none"
|
||||||
|
authenticationEndpoint = "https://mutated.example/key"
|
||||||
|
|
||||||
engine, err := promptkit.NewEngine(promptkit.Config{Sources: promptkit.ConfigurationSources{
|
engine, err := promptkit.NewEngine(promptkit.Config{Sources: promptkit.ConfigurationSources{
|
||||||
Main: &configkit.Input{Source: configkit.Mapping("versions", map[string]any{
|
Underlays: []configkit.Underlay{{Inputs: []configkit.Input{{Source: source}}}},
|
||||||
"prompts": map[string]any{"hello": map[string]any{
|
|
||||||
"1": definition("first"), "2": definition("second"),
|
|
||||||
}},
|
|
||||||
})},
|
|
||||||
}})
|
}})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("construct engine: %v", err)
|
t.Fatalf("construct engine with dangling diagnostic default: %v", err)
|
||||||
}
|
}
|
||||||
if result, err := engine.Prepare(context.Background(), promptkit.RunRequest{PromptID: "hello"}); result != nil || !errors.Is(err, promptkit.ErrPromptLoad) {
|
inspection, err := engine.InspectConfiguration()
|
||||||
t.Fatalf("ambiguous preparation = (%#v, %v), want ErrPromptLoad", result, err)
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
var effective bytes.Buffer
|
||||||
|
if err := inspection.WriteEffective(&effective); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
contents := effective.String()
|
||||||
|
for _, want := range []string{
|
||||||
|
"https://backend.example/v1",
|
||||||
|
"not-yet-listed",
|
||||||
|
"https://probe.example/ready?check=1",
|
||||||
|
" OPENROUTER_KEY ",
|
||||||
|
"https://probe.example/key?scope=current",
|
||||||
|
} {
|
||||||
|
if !strings.Contains(contents, want) {
|
||||||
|
t.Errorf("effective configuration does not contain %q:\n%s", want, contents)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, unwanted := range []string{
|
||||||
|
"mutated.example",
|
||||||
|
"mutated-profile",
|
||||||
|
} {
|
||||||
|
if strings.Contains(contents, unwanted) {
|
||||||
|
t.Errorf("effective configuration unexpectedly contains %q:\n%s", unwanted, contents)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestPreparationSelectsSinglePromptDefinitionByID(t *testing.T) {
|
||||||
|
engine := newSimpleEngine(t, "selected")
|
||||||
|
prepared, err := engine.Prepare(context.Background(), promptkit.RunRequest{PromptID: "prompt"})
|
||||||
|
if err != nil || prepared == nil || len(prepared.Messages) != 1 || prepared.Messages[0].Content != "selected" {
|
||||||
|
t.Fatalf("prepare prompt by ID = (%+v, %v)", prepared, err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -7,8 +7,8 @@ import (
|
|||||||
"sync/atomic"
|
"sync/atomic"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/ConfigKit"
|
"go.maximumdirect.net/configkit"
|
||||||
"gitea.maximumdirect.net/eric/promptkit"
|
"go.maximumdirect.net/promptkit"
|
||||||
)
|
)
|
||||||
|
|
||||||
type fakeLLMClient struct {
|
type fakeLLMClient struct {
|
||||||
@@ -60,14 +60,14 @@ func newSimpleEngine(t *testing.T, content string, options ...promptkit.Option)
|
|||||||
func simpleConfig(content string) promptkit.Config {
|
func simpleConfig(content string) promptkit.Config {
|
||||||
return promptkit.Config{Sources: promptkit.ConfigurationSources{
|
return promptkit.Config{Sources: promptkit.ConfigurationSources{
|
||||||
Main: &configkit.Input{Source: configkit.Mapping("consumer test", map[string]any{
|
Main: &configkit.Input{Source: configkit.Mapping("consumer test", map[string]any{
|
||||||
"profiles": map[string]any{"profile": map[string]any{
|
"profiles": []any{map[string]any{"id": "profile",
|
||||||
"endpoint": "http://example.test/v1", "model": "model",
|
"endpoint": "http://example.test/v1", "model": "model",
|
||||||
}},
|
}},
|
||||||
"prompts": map[string]any{"prompt": map[string]any{"1": map[string]any{
|
"prompts": []any{map[string]any{"id": "prompt",
|
||||||
"default_profile": "profile",
|
"default_profile": "profile",
|
||||||
"messages": []any{map[string]any{"role": "user", "content": content}},
|
"messages": []any{map[string]any{"role": "user", "content": content}},
|
||||||
"output": map[string]any{"format": "text", "validation_mode": "none"},
|
"output": map[string]any{"format": "text", "validation_mode": "none"},
|
||||||
}}},
|
}},
|
||||||
})},
|
})},
|
||||||
}}
|
}}
|
||||||
}
|
}
|
||||||
|
|||||||
16
convert.go
16
convert.go
@@ -5,8 +5,8 @@ import (
|
|||||||
"reflect"
|
"reflect"
|
||||||
"unicode/utf8"
|
"unicode/utf8"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/domain"
|
"go.maximumdirect.net/promptkit/internal/domain"
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/jsonvalue"
|
"go.maximumdirect.net/promptkit/internal/jsonvalue"
|
||||||
)
|
)
|
||||||
|
|
||||||
func toDomainRunRequest(req RunRequest) (domain.RunRequest, error) {
|
func toDomainRunRequest(req RunRequest) (domain.RunRequest, error) {
|
||||||
@@ -25,7 +25,6 @@ func toDomainRunRequest(req RunRequest) (domain.RunRequest, error) {
|
|||||||
}
|
}
|
||||||
return domain.RunRequest{
|
return domain.RunRequest{
|
||||||
PromptID: req.PromptID,
|
PromptID: req.PromptID,
|
||||||
PromptVersion: req.PromptVersion,
|
|
||||||
ProfileID: req.ProfileID,
|
ProfileID: req.ProfileID,
|
||||||
SessionID: req.SessionID,
|
SessionID: req.SessionID,
|
||||||
APIKey: req.APIKey,
|
APIKey: req.APIKey,
|
||||||
@@ -73,7 +72,6 @@ func fromDomainPreparedRun(prepared *domain.PreparedRun) *PreparedRun {
|
|||||||
}
|
}
|
||||||
return &PreparedRun{
|
return &PreparedRun{
|
||||||
PromptID: prepared.PromptID,
|
PromptID: prepared.PromptID,
|
||||||
PromptVersion: prepared.PromptVersion,
|
|
||||||
PromptHash: prepared.PromptHash,
|
PromptHash: prepared.PromptHash,
|
||||||
SelectedProfileID: prepared.SelectedProfileID,
|
SelectedProfileID: prepared.SelectedProfileID,
|
||||||
SelectedBackendID: prepared.SelectedBackendID,
|
SelectedBackendID: prepared.SelectedBackendID,
|
||||||
@@ -100,7 +98,6 @@ func fromDomainRunResult(result *domain.RunResult) *RunResult {
|
|||||||
RawOutput: result.RawOutput,
|
RawOutput: result.RawOutput,
|
||||||
Validation: fromDomainValidationResult(result.Validation),
|
Validation: fromDomainValidationResult(result.Validation),
|
||||||
PromptID: result.PromptID,
|
PromptID: result.PromptID,
|
||||||
PromptVersion: result.PromptVersion,
|
|
||||||
PromptHash: result.PromptHash,
|
PromptHash: result.PromptHash,
|
||||||
SessionID: result.SessionID,
|
SessionID: result.SessionID,
|
||||||
RenderedPromptHash: result.RenderedPromptHash,
|
RenderedPromptHash: result.RenderedPromptHash,
|
||||||
@@ -211,6 +208,12 @@ func toDomainExecutionTargetOverride(override *ExecutionTargetOverride) (*domain
|
|||||||
}
|
}
|
||||||
|
|
||||||
func fromDomainExecutionTarget(target domain.ExecutionTarget) ExecutionTarget {
|
func fromDomainExecutionTarget(target domain.ExecutionTarget) ExecutionTarget {
|
||||||
|
return fromDomainExecutionTargetWithOwnedParams(target, copyAnyMap(target.ExtraParams))
|
||||||
|
}
|
||||||
|
|
||||||
|
// fromDomainExecutionTargetWithOwnedParams projects scalar settings and takes
|
||||||
|
// ownership of extraParams, which the caller has already copied.
|
||||||
|
func fromDomainExecutionTargetWithOwnedParams(target domain.ExecutionTarget, extraParams map[string]any) ExecutionTarget {
|
||||||
return ExecutionTarget{
|
return ExecutionTarget{
|
||||||
BackendID: target.BackendID,
|
BackendID: target.BackendID,
|
||||||
Endpoint: target.Endpoint,
|
Endpoint: target.Endpoint,
|
||||||
@@ -222,7 +225,7 @@ func fromDomainExecutionTarget(target domain.ExecutionTarget) ExecutionTarget {
|
|||||||
ServiceTier: target.ServiceTier,
|
ServiceTier: target.ServiceTier,
|
||||||
ReasoningEffort: target.ReasoningEffort,
|
ReasoningEffort: target.ReasoningEffort,
|
||||||
APIKeyEnv: target.APIKeyEnv,
|
APIKeyEnv: target.APIKeyEnv,
|
||||||
ExtraParams: copyAnyMap(target.ExtraParams),
|
ExtraParams: extraParams,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -252,7 +255,6 @@ func fromDomainPromptInspection(inspection *domain.PromptInspection) *PromptInsp
|
|||||||
}
|
}
|
||||||
return &PromptInspection{
|
return &PromptInspection{
|
||||||
PromptID: inspection.PromptID,
|
PromptID: inspection.PromptID,
|
||||||
PromptVersion: inspection.PromptVersion,
|
|
||||||
PromptHash: inspection.PromptHash,
|
PromptHash: inspection.PromptHash,
|
||||||
DefaultProfileID: inspection.DefaultProfileID,
|
DefaultProfileID: inspection.DefaultProfileID,
|
||||||
Inputs: inputs,
|
Inputs: inputs,
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ import (
|
|||||||
"strings"
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/domain"
|
"go.maximumdirect.net/promptkit/internal/domain"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestToDomainAppendedMessages(t *testing.T) {
|
func TestToDomainAppendedMessages(t *testing.T) {
|
||||||
|
|||||||
231
docs/consumers/configuration-migration.md
Normal file
231
docs/consumers/configuration-migration.md
Normal file
@@ -0,0 +1,231 @@
|
|||||||
|
# Configuration And API Migration
|
||||||
|
|
||||||
|
This breaking pre-v1 minor migration adopts Promptkit's vanity module path,
|
||||||
|
changes the v0.16-era keyed resources to identified lists, adopts ConfigKit v1,
|
||||||
|
and removes prompt-version labels.
|
||||||
|
Promptkit does not install a provider catalog; applications choose configuration
|
||||||
|
inputs explicitly, and execution selects one prompt by its exact ID. This guide
|
||||||
|
explains the shape changes and decisions an application must make; it is not an
|
||||||
|
automatic migration tool. The [framework format reference](../formats.md) owns
|
||||||
|
the current configuration contract, and the root package GoDoc owns exact API
|
||||||
|
signatures and errors.
|
||||||
|
|
||||||
|
## Update Go Imports
|
||||||
|
|
||||||
|
Promptkit's module and public package import path is now
|
||||||
|
`go.maximumdirect.net/promptkit`, replacing
|
||||||
|
`gitea.maximumdirect.net/eric/promptkit`. Update application, library, test, and
|
||||||
|
generated imports, then select a release using the new declaration:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
go get go.maximumdirect.net/promptkit@VERSION
|
||||||
|
go mod tidy
|
||||||
|
```
|
||||||
|
|
||||||
|
Replace `VERSION` with a release that declares the vanity module path.
|
||||||
|
Earlier tags, including v0.16.0, retain their original module declaration and
|
||||||
|
use the former import path. No permanent `replace` directive is needed for the
|
||||||
|
cutover. Source browser, licensing, and hosted-release links continue to use
|
||||||
|
the Forge repository URLs, independently of Go's module identifier.
|
||||||
|
|
||||||
|
The package name remains `promptkit`. The path change itself does not rename
|
||||||
|
exported APIs or change their behavior, but Go treats packages imported through
|
||||||
|
the two paths as distinct. Update dependent packages that exchange Promptkit
|
||||||
|
types together and review any old-path dependencies retained after tidying.
|
||||||
|
The configuration and API adaptations below are also part of this migration.
|
||||||
|
|
||||||
|
## Select And Compose The Configuration You Need
|
||||||
|
|
||||||
|
Supply each backend, profile, prompt, schema, and collection source that the
|
||||||
|
application intends to use. Promptkit does not discover directories or install
|
||||||
|
provider definitions implicitly. An application may select an explicit
|
||||||
|
collection input with `CollectionInput`:
|
||||||
|
|
||||||
|
```go
|
||||||
|
input, err := promptkit.CollectionInput(
|
||||||
|
"openrouter",
|
||||||
|
configkit.File("config/openrouter.yaml"),
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
engine, err := promptkit.NewEngine(promptkit.Config{
|
||||||
|
Sources: promptkit.ConfigurationSources{
|
||||||
|
Underlays: []configkit.Underlay{{Inputs: []configkit.Input{input}}},
|
||||||
|
},
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
Collection resource IDs are local IDs, while their runtime identities are
|
||||||
|
qualified. For example, a profile with `id: gemini-flash-latest` in collection
|
||||||
|
`openrouter` is selected as `openrouter/gemini-flash-latest`. Stored backend,
|
||||||
|
prompt-default, and other resource references must use their exact intended IDs;
|
||||||
|
Promptkit does not rewrite references when a source is mounted. `extends`
|
||||||
|
selects a sibling ID in the same list, not a cross-collection reference.
|
||||||
|
Review collisions and all references when moving resources into collections.
|
||||||
|
|
||||||
|
The optional source-root `version` header now accepts `2` or `"2"`; headerless
|
||||||
|
sources remain valid. A collection's `release_version` remains an optional
|
||||||
|
label. Prompt-version labels have been removed: choose one definition per ID
|
||||||
|
and store any application-specific release label outside Promptkit. In a
|
||||||
|
standalone imported prompt item, root `version` is a source header, not a label.
|
||||||
|
|
||||||
|
For example, change a version-keyed definition:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
prompts:
|
||||||
|
report:
|
||||||
|
"2.0":
|
||||||
|
messages:
|
||||||
|
- role: user
|
||||||
|
content: Review this report.
|
||||||
|
output:
|
||||||
|
format: text
|
||||||
|
validation_mode: none
|
||||||
|
```
|
||||||
|
|
||||||
|
to one identified definition:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
prompts:
|
||||||
|
- id: report
|
||||||
|
messages:
|
||||||
|
- role: user
|
||||||
|
content: Review this report.
|
||||||
|
output:
|
||||||
|
format: text
|
||||||
|
validation_mode: none
|
||||||
|
```
|
||||||
|
|
||||||
|
The same conversion applies to backends and profiles. Sibling inheritance uses
|
||||||
|
identity references, and a later same-ID record replaces the whole lower record:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
profiles:
|
||||||
|
- id: base
|
||||||
|
endpoint: https://example.invalid/v1
|
||||||
|
model: example-model
|
||||||
|
- id: fast
|
||||||
|
extends: {id: base}
|
||||||
|
timeout_seconds: 30
|
||||||
|
```
|
||||||
|
|
||||||
|
To customize a lower resource's fields, add a distinct inherited variant as
|
||||||
|
above; when replacing the same ID, supply the complete intended record. Generic
|
||||||
|
append, replace, imports, and inheritance are described by the
|
||||||
|
[ConfigKit v1 configuration contract](https://forge.maximumdirect.net/base-layer/configkit/src/tag/v1.0.0/docs/config.md).
|
||||||
|
Source-root controls are now `config:`, not `configkit:`. Imports are optional
|
||||||
|
unless the selected import declares `required: true`.
|
||||||
|
|
||||||
|
Update ConfigKit imports to `go.maximumdirect.net/configkit` at v1.0.0: its Go
|
||||||
|
types are incompatible with the old module path. Promptkit now requires Go
|
||||||
|
1.27.0 or newer. Source builders take ordered slices with explicit IDs:
|
||||||
|
|
||||||
|
```go
|
||||||
|
endpoint, model := "https://example.invalid/v1", "example-model"
|
||||||
|
base := "base"
|
||||||
|
source := promptkit.ProfileSource("application", []promptkit.ProfileConfig{
|
||||||
|
{ID: "base", Endpoint: &endpoint, Model: &model},
|
||||||
|
{ID: "fast", Extends: &base},
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
Replace former maps passed to `BackendSource` in the same way, setting each
|
||||||
|
`BackendConfig.ID`. Duplicates are retained for loading to reject. Resource
|
||||||
|
inspection paths now address list indexes, for example
|
||||||
|
`configkit.Keys("profiles").Index(0).Key("model")`. Configuration inspection
|
||||||
|
and diffs expose composed values and provenance, while `InspectProfile` and
|
||||||
|
other interpreted views expose Promptkit normalization and defaults; the views
|
||||||
|
are not promised to be identical.
|
||||||
|
|
||||||
|
Remove `PromptVersion` and `PromptIdentity.Version` uses and the corresponding
|
||||||
|
`prompt_version` JSON members. Prompt hashes are opaque equality values and may
|
||||||
|
change when the removed field no longer participates in hashing.
|
||||||
|
|
||||||
|
## Identity Mapping
|
||||||
|
|
||||||
|
The reviewed catalog identities have slash-free profile keys. Their documented
|
||||||
|
mapping is:
|
||||||
|
|
||||||
|
| Previous identity | Namespaced identity or action |
|
||||||
|
| --- | --- |
|
||||||
|
| Backend `openrouter` | `openrouter/default` |
|
||||||
|
| Backend `rakestrawhome` | `rakestrawhome/default` |
|
||||||
|
| Each OpenRouter catalog profile `p` | `openrouter/p`, retaining the exact local key `p` |
|
||||||
|
| Profile `rakestrawhome-gemma-4-31b` | `rakestrawhome/rakestrawhome-gemma-4-31b` |
|
||||||
|
| Built-in `promptkit-openrouter-standard` | No automatic replacement; optionally define caller profile `openrouter/standard` |
|
||||||
|
| Built-in `promptkit-openrouter-auto` | No automatic replacement; optionally define caller profile `openrouter/auto` |
|
||||||
|
|
||||||
|
These are conversion examples, not aliases or bundled resources. Mounting old
|
||||||
|
`/v3` assets does not update backend references, profile inheritance, prompt
|
||||||
|
defaults, or diagnostic defaults inside them. Edit those values to the exact
|
||||||
|
qualified IDs you chose.
|
||||||
|
|
||||||
|
For example, an optional caller-owned standard profile may extend a selected
|
||||||
|
Gemini profile in the same `openrouter` collection:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
collections:
|
||||||
|
openrouter:
|
||||||
|
profiles:
|
||||||
|
- id: standard
|
||||||
|
extends: {id: gemini-flash-latest}
|
||||||
|
```
|
||||||
|
|
||||||
|
An optional auto profile may instead select the exact backend and model values:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
collections:
|
||||||
|
openrouter:
|
||||||
|
profiles:
|
||||||
|
- id: auto
|
||||||
|
backend: openrouter/default
|
||||||
|
model: openrouter/auto
|
||||||
|
```
|
||||||
|
|
||||||
|
Neither optional profile name is a Promptkit contract. Keep provider model
|
||||||
|
strings and settings as selected by the application, including any meaningful
|
||||||
|
prefixes. If a backend declares diagnostic defaults, update them to exact
|
||||||
|
qualified IDs; an unselected diagnostic default is not automatically made
|
||||||
|
resolvable by migration.
|
||||||
|
|
||||||
|
## Prompt Selection API
|
||||||
|
|
||||||
|
Prompt selection is ID-only. Remove version selectors from calls to `Run`,
|
||||||
|
`Prepare`, `PrepareExecution`, `ValidateRequest`, `InspectRequirements`, and
|
||||||
|
`SmokeTest`. Remove the `PromptVersion` field from `RunRequest`,
|
||||||
|
`RequirementInspectionRequest`, and `SmokeTestRequest`; `InspectPrompt` now
|
||||||
|
has the form `InspectPrompt(ctx, promptID)`. For example, select the prompt
|
||||||
|
explicitly in the request rather than setting a version selector:
|
||||||
|
|
||||||
|
```go
|
||||||
|
request := promptkit.RunRequest{
|
||||||
|
PromptID: "support/report",
|
||||||
|
ProfileID: "support/standard",
|
||||||
|
}
|
||||||
|
_, err = engine.Run(ctx, request)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
If the former format contained multiple versions under one ID, choose the one
|
||||||
|
definition the application should install. Promptkit no longer retains or
|
||||||
|
returns its former descriptive label.
|
||||||
|
|
||||||
|
The public inventory APIs can help an operator inspect a captured effective
|
||||||
|
configuration: `ListProfiles`, `ListPrompts`, and `ListBackends` return exact
|
||||||
|
identities, while `ListNamespaces` and `ListCollections` expose resource-bearing
|
||||||
|
namespaces and effective collection declarations. Inventory does not select
|
||||||
|
which configuration version the application should deploy.
|
||||||
|
|
||||||
|
## Deployment Selection Remains With The Application
|
||||||
|
|
||||||
|
Applications decide which checked-in, embedded, operator-supplied, or
|
||||||
|
programmatic inputs to compose for each deployment. They also decide when to
|
||||||
|
construct a replacement engine after changing those sources. Promptkit does
|
||||||
|
not fetch catalog updates, select provider availability, validate upstream
|
||||||
|
catalog release status, or automatically migrate arbitrary consumer files.
|
||||||
|
The maintained [offline collection example](../../examples/go-library/prepare/main.go)
|
||||||
|
shows explicit source selection, local imports, layering, a scoped view, and
|
||||||
|
operator inventory without a provider call.
|
||||||
@@ -12,9 +12,21 @@ file contracts.
|
|||||||
Import the package as:
|
Import the package as:
|
||||||
|
|
||||||
```go
|
```go
|
||||||
import "gitea.maximumdirect.net/eric/promptkit"
|
import "go.maximumdirect.net/promptkit"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
For migration from the former module path, see
|
||||||
|
[Update Go Imports](configuration-migration.md#update-go-imports).
|
||||||
|
|
||||||
|
Configuration APIs use `go.maximumdirect.net/configkit` v1.0.0. Its types are
|
||||||
|
not interchangeable with the old ConfigKit module path.
|
||||||
|
|
||||||
|
The maintained [offline preparation example](../../examples/go-library/prepare/main.go)
|
||||||
|
demonstrates explicit collection composition and inventory. Applications
|
||||||
|
adapting older provider or versioned-prompt configuration can use the
|
||||||
|
[configuration migration guide](configuration-migration.md) for the required
|
||||||
|
caller-owned choices.
|
||||||
|
|
||||||
The following Go fragments are illustrative and omit surrounding package,
|
The following Go fragments are illustrative and omit surrounding package,
|
||||||
import, and error-handling code. Use the maintained examples for complete
|
import, and error-handling code. Use the maintained examples for complete
|
||||||
programs.
|
programs.
|
||||||
@@ -22,7 +34,8 @@ programs.
|
|||||||
## Go Compatibility
|
## Go Compatibility
|
||||||
|
|
||||||
The `go` directive in the selected release's [module metadata](../../go.mod)
|
The `go` directive in the selected release's [module metadata](../../go.mod)
|
||||||
declares its minimum supported consumer Go version. Maintainers build and
|
declares its minimum supported consumer Go version, currently Go 1.27.0.
|
||||||
|
Maintainers build and
|
||||||
validate releases with the locally selected Go patch release; the minimum
|
validate releases with the locally selected Go patch release; the minimum
|
||||||
does not simply track that patch version.
|
does not simply track that patch version.
|
||||||
|
|
||||||
@@ -63,6 +76,34 @@ new engine to observe configuration edits. See the [constructor GoDoc](../../eng
|
|||||||
for the exact public contract and the [framework format reference](../formats.md)
|
for the exact public contract and the [framework format reference](../formats.md)
|
||||||
for definition fields.
|
for definition fields.
|
||||||
|
|
||||||
|
### Use Scoped Engine Views
|
||||||
|
|
||||||
|
Create a view when an application wants short request IDs to resolve within a
|
||||||
|
selected collection:
|
||||||
|
|
||||||
|
```go
|
||||||
|
scoped, err := engine.WithNamespaces(promptkit.Namespaces{
|
||||||
|
Prompt: "support",
|
||||||
|
Profile: "support",
|
||||||
|
})
|
||||||
|
if err != nil { return err }
|
||||||
|
|
||||||
|
prepared, err := scoped.Prepare(ctx, promptkit.RunRequest{
|
||||||
|
PromptID: "answer",
|
||||||
|
ProfileID: "concise",
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
Execution, preparation, prompt/profile inspection, requirement inspection, and
|
||||||
|
smoke diagnostics qualify slashless caller selections with their respective
|
||||||
|
namespaces. Already-qualified IDs pass through unchanged; configured defaults
|
||||||
|
and references are not rewritten. Each call replaces the view's scope defaults,
|
||||||
|
including clearing a scope with an empty field, without changing the receiver
|
||||||
|
or rebuilding its captured configuration and execution collaborators.
|
||||||
|
Namespace syntax is checked when creating the view; resource existence is
|
||||||
|
checked when selected. Configuration inspection remains global. See
|
||||||
|
[`WithNamespaces`](../../namespaces.go) for the exact public contract.
|
||||||
|
|
||||||
## Supply Embedded Application Defaults
|
## Supply Embedded Application Defaults
|
||||||
|
|
||||||
Use `FilesystemInputs` for embedded defaults and `DirectoryInputs` for an
|
Use `FilesystemInputs` for embedded defaults and `DirectoryInputs` for an
|
||||||
@@ -74,8 +115,8 @@ defaults, err := promptkit.FilesystemInputs("embedded defaults", applicationFS,
|
|||||||
if err != nil { return err }
|
if err != nil { return err }
|
||||||
operator, err := promptkit.DirectoryInputs(operatorDirectory)
|
operator, err := promptkit.DirectoryInputs(operatorDirectory)
|
||||||
if err != nil { return err }
|
if err != nil { return err }
|
||||||
profile := promptkit.ProfileSource("application choices", map[string]promptkit.ProfileConfig{
|
profile := promptkit.ProfileSource("application choices", []promptkit.ProfileConfig{
|
||||||
"summary": {Model: &selectedModel},
|
{ID: "summary", Endpoint: &selectedEndpoint, Model: &selectedModel},
|
||||||
})
|
})
|
||||||
engine, err := promptkit.NewEngine(promptkit.Config{Sources: promptkit.ConfigurationSources{
|
engine, err := promptkit.NewEngine(promptkit.Config{Sources: promptkit.ConfigurationSources{
|
||||||
Underlays: []configkit.Underlay{
|
Underlays: []configkit.Underlay{
|
||||||
@@ -86,7 +127,9 @@ engine, err := promptkit.NewEngine(promptkit.Config{Sources: promptkit.Configura
|
|||||||
}})
|
}})
|
||||||
```
|
```
|
||||||
|
|
||||||
Only add the operator group when the application selects that directory; an
|
Each later same-ID resource replaces the complete earlier record; use a distinct
|
||||||
|
inherited sibling for field-level customization. Only add the operator group
|
||||||
|
when the application selects that directory; an
|
||||||
explicitly selected missing or unreadable root is an error. Each helper finds
|
explicitly selected missing or unreadable root is an error. Each helper finds
|
||||||
`.yaml` and `.yml` files recursively and disables imports by default. The
|
`.yaml` and `.yml` files recursively and disables imports by default. The
|
||||||
caller may enable imports on individual inputs. A nil `Sources.Main` is an
|
caller may enable imports on individual inputs. A nil `Sources.Main` is an
|
||||||
@@ -97,8 +140,8 @@ labeled mapping as an input. A mapping owns a snapshot of supported values:
|
|||||||
|
|
||||||
```go
|
```go
|
||||||
document := configkit.Mapping("application configuration", map[string]any{
|
document := configkit.Mapping("application configuration", map[string]any{
|
||||||
"profiles": map[string]any{
|
"profiles": []any{
|
||||||
"local-summary": map[string]any{
|
map[string]any{"id": "local-summary",
|
||||||
"backend": "local", "model": "example-model",
|
"backend": "local", "model": "example-model",
|
||||||
"temperature": nil, // Suppress an inherited provider control.
|
"temperature": nil, // Suppress an inherited provider control.
|
||||||
},
|
},
|
||||||
@@ -109,8 +152,8 @@ input := configkit.Input{Source: document}
|
|||||||
```
|
```
|
||||||
|
|
||||||
`ProfileSource` and `BackendSource` are smaller typed conveniences when null
|
`ProfileSource` and `BackendSource` are smaller typed conveniences when null
|
||||||
is not needed. A caller underlay can overlay catalog backend fields just as it
|
is not needed. Backend and profile definitions are supplied by the caller;
|
||||||
can overlay profiles; there is no registration-only backend namespace.
|
there is no registration-only backend namespace.
|
||||||
|
|
||||||
When configuration or message files change, build and validate a new engine,
|
When configuration or message files change, build and validate a new engine,
|
||||||
then switch the application to that engine for subsequent work. Existing
|
then switch the application to that engine for subsequent work. Existing
|
||||||
@@ -118,11 +161,15 @@ engines and prepared handles retain their captured definitions; schema and
|
|||||||
request artifact resources still follow their runtime lifecycle. Inspection
|
request artifact resources still follow their runtime lifecycle. Inspection
|
||||||
does not watch or reload sources automatically.
|
does not watch or reload sources automatically.
|
||||||
|
|
||||||
## Discover Available Profiles And Prompts
|
## Discover Available Resources And Collections
|
||||||
|
|
||||||
Use [`Engine.ListProfiles`](../../listing.go) and
|
Use [`Engine.ListProfiles`](../../listing.go),
|
||||||
[`Engine.ListPrompts`](../../listing.go) to discover exact identities from the
|
[`Engine.ListPrompts`](../../listing.go), and
|
||||||
engine's final captured configuration, then inspect a selected prompt:
|
[`Engine.ListBackends`](../../listing.go) to discover exact identities from the
|
||||||
|
engine's final captured configuration. A scoped view filters by its respective
|
||||||
|
namespace by default; pass `NamespaceNamed`, `NamespaceUnqualified`, or
|
||||||
|
`NamespaceAll` to override that listing filter without changing execution
|
||||||
|
scope. Returned IDs remain full identities and can be used for exact selection:
|
||||||
|
|
||||||
```go
|
```go
|
||||||
profiles, err := engine.ListProfiles(ctx)
|
profiles, err := engine.ListProfiles(ctx)
|
||||||
@@ -141,7 +188,7 @@ if err != nil {
|
|||||||
}
|
}
|
||||||
if len(prompts) > 0 {
|
if len(prompts) > 0 {
|
||||||
selected := prompts[0]
|
selected := prompts[0]
|
||||||
inspection, err := engine.InspectPrompt(ctx, selected.ID, selected.Version)
|
inspection, err := engine.InspectPrompt(ctx, selected.ID)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -149,6 +196,12 @@ if len(prompts) > 0 {
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Use [`Engine.ListNamespaces`](../../listing.go) to discover resource-bearing
|
||||||
|
namespaces across the entire captured configuration, independent of view
|
||||||
|
scopes. [`Engine.ListCollections`](../../listing.go) reports effective
|
||||||
|
collection declarations, including metadata-only entries; it does not infer
|
||||||
|
collection metadata from resource membership or source history.
|
||||||
|
|
||||||
These lists describe effective membership, not ConfigKit contribution history,
|
These lists describe effective membership, not ConfigKit contribution history,
|
||||||
and do not promise that a profile is ready to execute. Use inspection for
|
and do not promise that a profile is ready to execute. Use inspection for
|
||||||
details and preparation to resolve request resources. The linked method GoDoc
|
details and preparation to resolve request resources. The linked method GoDoc
|
||||||
@@ -158,14 +211,15 @@ sensitive application data.
|
|||||||
## Inspect The Captured Configuration
|
## Inspect The Captured Configuration
|
||||||
|
|
||||||
Use [`Engine.InspectConfiguration`](../../configuration_inspection.go) for an
|
Use [`Engine.InspectConfiguration`](../../configuration_inspection.go) for an
|
||||||
operator-selected report of effective configuration, source descriptions,
|
operator-selected report of composed configuration, source descriptions,
|
||||||
diagnostics, and path history. For a literal ID containing a slash, construct
|
diagnostics, and path history. Configuration inspection uses list indexes in
|
||||||
the semantic path with `configkit.Keys`:
|
the collection's nested path rather than qualified runtime IDs. For a profile
|
||||||
|
at index `i` in collection `team`, construct the path with `configkit.Keys`:
|
||||||
|
|
||||||
```go
|
```go
|
||||||
view, err := engine.InspectConfiguration()
|
view, err := engine.InspectConfiguration()
|
||||||
if err != nil { return err }
|
if err != nil { return err }
|
||||||
path := configkit.Keys("profiles", "team/summary", "model")
|
path := configkit.Keys("collections", "team", "profiles").Index(i).Key("model")
|
||||||
explanation, found := view.Explain(path)
|
explanation, found := view.Explain(path)
|
||||||
if found && explanation.Effective.Redacted {
|
if found && explanation.Effective.Redacted {
|
||||||
// Apply the application's disclosure policy before sharing the report.
|
// Apply the application's disclosure policy before sharing the report.
|
||||||
@@ -176,11 +230,110 @@ if found && explanation.Effective.Redacted {
|
|||||||
the application decides whether those reports may be disclosed. Credential-
|
the application decides whether those reports may be disclosed. Credential-
|
||||||
shaped provider keys are redacted, but arbitrary prompt and provider content
|
shaped provider keys are redacted, but arbitrary prompt and provider content
|
||||||
is not necessarily safe to share. Inspection uses the engine's captured result
|
is not necessarily safe to share. Inspection uses the engine's captured result
|
||||||
and does not reopen sources or resolve credentials. `InspectProfile` instead
|
and does not reopen sources or resolve credentials. It retains composed values
|
||||||
shows backend-completed execution settings for one profile, and `Prepare` or
|
and provenance rather than Promptkit's normalized/defaulted interpretation.
|
||||||
|
`InspectProfile` instead shows backend-completed execution settings for one profile, and `Prepare` or
|
||||||
`PreparedExecution.Details` shows request-specific rendered messages, inputs,
|
`PreparedExecution.Details` shows request-specific rendered messages, inputs,
|
||||||
and validation resources. None of those views is a substitute for the others.
|
and validation resources. None of those views is a substitute for the others.
|
||||||
|
|
||||||
|
To review changes between two independently captured configurations, compare
|
||||||
|
their inspection views:
|
||||||
|
|
||||||
|
```go
|
||||||
|
earlier, err := earlierEngine.InspectConfiguration()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
later, err := candidateEngine.InspectConfiguration()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
differences, err := earlier.Diff(later)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
for _, difference := range differences {
|
||||||
|
if difference.HiddenChanged {
|
||||||
|
// Report a protected change without inferring its value.
|
||||||
|
}
|
||||||
|
if difference.Left.Redacted || difference.Right.Redacted {
|
||||||
|
// Apply the application's disclosure policy before presenting snapshots.
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
See the [`ConfigurationInspection.Diff` GoDoc](../../configuration_inspection.go)
|
||||||
|
and ConfigKit's [v1.0.0 effective-configuration diff guidance](https://forge.maximumdirect.net/base-layer/configkit/src/tag/v1.0.0/docs/config.md#effective-configuration-diffs)
|
||||||
|
for the exact comparison contract. The operation compares only frozen effective
|
||||||
|
configuration values: it does not reread external files or compare their
|
||||||
|
contents, resolved credential contents, later execution preparation, or
|
||||||
|
request-specific overrides. An empty diff is not proof of equivalent execution.
|
||||||
|
Records can contain ordinary application data, so use the application's
|
||||||
|
disclosure policy when presenting them.
|
||||||
|
|
||||||
|
## Run Explicit Smoke Diagnostics
|
||||||
|
|
||||||
|
[`Engine.SmokeTest`](../../smoke_diagnostics.go) runs one explicit diagnostic
|
||||||
|
using a target resolved from the engine's captured configuration. It does not
|
||||||
|
execute the selected application prompt or its inputs, session, artifacts, or
|
||||||
|
output schema. Unlike the offline examples and default test suite, calling it
|
||||||
|
can contact the selected provider and use configured credentials. It is a
|
||||||
|
consumer operation, not an automatic readiness verdict or a release check.
|
||||||
|
|
||||||
|
For example, a caller can request the built-in text inference check and treat
|
||||||
|
its optional fact as an observation rather than assuming that a nil Go error
|
||||||
|
means success:
|
||||||
|
|
||||||
|
```go
|
||||||
|
report, err := engine.SmokeTest(ctx, promptkit.SmokeTestRequest{
|
||||||
|
Kind: promptkit.SmokeTestTextInference,
|
||||||
|
ProfileID: profileID,
|
||||||
|
APIKey: apiKey,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
if report != nil {
|
||||||
|
retainDisclosureSafeSummary(report)
|
||||||
|
}
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if report != nil {
|
||||||
|
matched := report.Facts.ExpectedTextMatched
|
||||||
|
switch {
|
||||||
|
case matched == nil:
|
||||||
|
// The comparison was not evaluated or is unknown/inapplicable.
|
||||||
|
case *matched:
|
||||||
|
// The private expected-text comparison matched.
|
||||||
|
default:
|
||||||
|
// It did not match; the operation may still have concluded normally.
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
A nil Go error means the diagnostic concluded, not that its finding was
|
||||||
|
positive. Fact pointers are tri-state: nil means unknown, not evaluated, or
|
||||||
|
inapplicable. Reports contain factual observations and effective settings, not
|
||||||
|
generated text or provider bodies; identifiers and settings can still be
|
||||||
|
sensitive. The
|
||||||
|
[`SmokeTest` GoDoc](../../smoke_diagnostics.go) owns selection precedence,
|
||||||
|
exact fields, timeout and retry behavior, supported transports, and disclosure
|
||||||
|
details.
|
||||||
|
|
||||||
|
Caller cancellation can return both an error and a partial report. Preserve the
|
||||||
|
context error identity and inspect any available observations before returning:
|
||||||
|
|
||||||
|
```go
|
||||||
|
report, err := engine.SmokeTest(ctx, request)
|
||||||
|
if report != nil {
|
||||||
|
retainDisclosureSafeSummary(report)
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
if errors.Is(err, context.Canceled) || errors.Is(err, context.DeadlineExceeded) {
|
||||||
|
// The report may describe work completed before interruption.
|
||||||
|
}
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
## Inspect A Prompt Before Preparation
|
## Inspect A Prompt Before Preparation
|
||||||
|
|
||||||
Use [`Engine.InspectPrompt`](../../engine.go) to check one configured prompt's
|
Use [`Engine.InspectPrompt`](../../engine.go) to check one configured prompt's
|
||||||
@@ -188,7 +341,7 @@ declared inputs and output workflow without creating placeholder inputs or
|
|||||||
resolving a profile:
|
resolving a profile:
|
||||||
|
|
||||||
```go
|
```go
|
||||||
inspection, err := engine.InspectPrompt(ctx, "meeting.summary", "")
|
inspection, err := engine.InspectPrompt(ctx, "meeting.summary")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -249,6 +402,41 @@ conditional entries. Do not treat an empty partial inventory as proof that no
|
|||||||
input bindings are needed. See the method's [GoDoc](../../requirements.go) for
|
input bindings are needed. See the method's [GoDoc](../../requirements.go) for
|
||||||
the exact classifications, supported syntax, ownership, and error contract.
|
the exact classifications, supported syntax, ownership, and error contract.
|
||||||
|
|
||||||
|
## Validate A Concrete Request
|
||||||
|
|
||||||
|
Use [`Engine.ValidateRequest`](../../engine.go) when the application has a
|
||||||
|
complete `RunRequest` and needs to know whether that concrete invocation passes
|
||||||
|
preparation:
|
||||||
|
|
||||||
|
```go
|
||||||
|
request := promptkit.RunRequest{
|
||||||
|
PromptID: "meeting.summary",
|
||||||
|
Vars: map[string]string{"audience": "project leads"},
|
||||||
|
Inputs: map[string]promptkit.ArtifactRef{
|
||||||
|
"note": promptkit.Inline("Synthetic meeting notes"),
|
||||||
|
},
|
||||||
|
}
|
||||||
|
if err := engine.ValidateRequest(ctx, request); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Unlike `InspectRequirements`, this checks supplied values, the selected template
|
||||||
|
branches, and request bindings through the existing preparation path. It checks
|
||||||
|
only this invocation, does not aggregate errors, and loads every supplied input
|
||||||
|
according to ordinary preparation behavior, even if a branch does not use it.
|
||||||
|
It makes no model call and returns no prepared snapshot, but artifact and schema
|
||||||
|
resource I/O and its time and memory costs remain. Success does not certify
|
||||||
|
provider acceptance or later execution success. See the method's GoDoc for its
|
||||||
|
exact error and context behavior.
|
||||||
|
|
||||||
|
Scriptorium can map the returned error to its own diagnostics and exit status.
|
||||||
|
Its `validate` and `run` commands should construct equivalent requests for
|
||||||
|
equivalent caller inputs so their preparation behavior agrees. Separate
|
||||||
|
subprocess calls prepare independently; an opaque `PrepareExecution` handle
|
||||||
|
cannot be transferred from `validate` to `run`. Use `PrepareExecution` when one
|
||||||
|
process and engine must execute the exact prepared snapshot.
|
||||||
|
|
||||||
## Prepare Without Model Execution
|
## Prepare Without Model Execution
|
||||||
|
|
||||||
[`Engine.Prepare`](../../engine.go) resolves the selected prompt and profile,
|
[`Engine.Prepare`](../../engine.go) resolves the selected prompt and profile,
|
||||||
@@ -269,8 +457,11 @@ prepared, err := engine.Prepare(ctx, promptkit.RunRequest{
|
|||||||
The maintained
|
The maintained
|
||||||
[offline preparation example](../../examples/go-library/prepare/main.go)
|
[offline preparation example](../../examples/go-library/prepare/main.go)
|
||||||
shows a complete runnable setup with a prompt file, in-memory profile, and
|
shows a complete runnable setup with a prompt file, in-memory profile, and
|
||||||
inline input. Exact request requirements and prepared-result fields belong to
|
inline input. It demonstrates validation and preparation with the same request
|
||||||
the [`RunRequest` and `PreparedRun` GoDoc](../../types.go).
|
to make the two operations concrete; this performs preparation twice and is
|
||||||
|
illustrative, not a requirement to validate before `Prepare` or `Run`. Exact
|
||||||
|
request requirements and prepared-result fields belong to the
|
||||||
|
[`RunRequest` and `PreparedRun` GoDoc](../../types.go).
|
||||||
|
|
||||||
## Prepare Now And Execute The Same Snapshot Later
|
## Prepare Now And Execute The Same Snapshot Later
|
||||||
|
|
||||||
@@ -440,7 +631,7 @@ copy, and credential behavior. The
|
|||||||
interact with prompt definitions, layered profiles, built-ins, schemas, and
|
interact with prompt definitions, layered profiles, built-ins, schemas, and
|
||||||
framework defaults.
|
framework defaults.
|
||||||
|
|
||||||
For programmatic profiles, use [`ProfileSource`](../../profiles.go) with keyed
|
For programmatic profiles, use [`ProfileSource`](../../profiles.go) with identified
|
||||||
`ProfileConfig` values. Nil fields are omitted; pointers preserve explicit
|
`ProfileConfig` values. Nil fields are omitted; pointers preserve explicit
|
||||||
zero, false, and blank values. Raw `configkit.Mapping` expresses explicit null.
|
zero, false, and blank values. Raw `configkit.Mapping` expresses explicit null.
|
||||||
|
|
||||||
@@ -453,100 +644,32 @@ and `WithBackend` options have no compatibility wrappers. Use
|
|||||||
`DirectoryInputs` or `FilesystemInputs` for a strict-composition file group,
|
`DirectoryInputs` or `FilesystemInputs` for a strict-composition file group,
|
||||||
ConfigKit file inputs for individual files, and `ProfileSource`,
|
ConfigKit file inputs for individual files, and `ProfileSource`,
|
||||||
`BackendSource`, or `configkit.Mapping` for programmatic values. Backend IDs
|
`BackendSource`, or `configkit.Mapping` for programmatic values. Backend IDs
|
||||||
are keys in configuration, not registrations. Choose caller underlays in
|
are fields in configuration, not registrations. Choose caller underlays in
|
||||||
fallback-to-operator-to-programmatic order; use `Sources.Main` for one final
|
fallback-to-operator-to-programmatic order; use `Sources.Main` for one final
|
||||||
highest-priority input.
|
highest-priority input.
|
||||||
|
|
||||||
Move embedded `id` and `version` fields into keyed `profiles` and `prompts`
|
Move resource IDs into identified `backends`, `profiles`, and `prompts` lists;
|
||||||
maps; convert `base_profile` to ConfigKit `extends`. IDs and references are
|
each prompt ID identifies one installed definition without a version label.
|
||||||
exact literal keys, without trimming. A supplied zero, false, or empty string
|
Convert `base_profile` to ConfigKit `extends: {id: parent}`. For the current
|
||||||
is now distinguishable from omission; null can clear or suppress an inherited
|
collection identity mapping, ID-only prompt selection, and required
|
||||||
field according to the [field table](../formats.md#defaults-and-overrides).
|
caller-owned choices, see the
|
||||||
Maps merge recursively across inheritance and layers. `{}` does not clear an
|
[configuration migration guide](configuration-migration.md). Exact current
|
||||||
inherited map: use null to clear the whole map. At request time, a literal
|
format, reference, inheritance, and presence semantics belong to the
|
||||||
`extra_params["extends"]` is ordinary provider data, not an inheritance
|
[framework format reference](../formats.md). Prompt text and static templates
|
||||||
instruction; a nonempty request ExtraParams map replaces configured params.
|
are captured at construction, not automatically reloaded between runs. Replace
|
||||||
Changing a model or backend does not clear unrelated explicit fields, though
|
the engine to pick up changed definitions or message files.
|
||||||
backend-derived defaults are applied after inheritance to the final backend.
|
|
||||||
|
|
||||||
Invalid final definitions, including unused ones, now fail `NewEngine`; only
|
|
||||||
request-dependent failures remain at preparation or execution. Prompt text
|
|
||||||
and static templates are captured at construction, not automatically reloaded
|
|
||||||
between runs. Replace the engine to pick up changed definitions or message
|
|
||||||
files. The [format reference](../formats.md) owns exact field and presence
|
|
||||||
rules; the maintained examples show complete runnable workflows.
|
|
||||||
|
|
||||||
### Choose A Profile Ownership Model
|
### Choose A Profile Ownership Model
|
||||||
|
|
||||||
Choose the profile source that matches the application's continuity needs:
|
Supply backend and profile definitions through the configuration sources your
|
||||||
|
application selects. PromptKit does not install provider catalogs or built-in
|
||||||
- Select `promptkit-openrouter-standard` or `promptkit-openrouter-auto` when
|
profile inventories; conventional backend ID constants are names only. Define
|
||||||
the maintained literal name is the desired consumer contract. Their current
|
the model, endpoint, credentials lookup, and settings that your application
|
||||||
selections are in the [format reference](../formats.md#built-in-profile-catalog).
|
intends to support. A profile may inherit a sibling profile by its local key in
|
||||||
- Select an external catalog profile directly when the application accepts that
|
the same root or collection list; its backend reference uses the exact
|
||||||
profile's catalog volatility. The selected external inventories are linked
|
configured identity. Caller-selected source layers determine the final values. The
|
||||||
from the [format reference](../formats.md#external-profile-inventories).
|
[format reference](../formats.md) describes the definition fields and
|
||||||
- Define a complete application-owned profile with an explicit backend or
|
composition rules.
|
||||||
endpoint, model, and settings when the application owns those choices.
|
|
||||||
|
|
||||||
An application profile that inherits an external base follows later changes to
|
|
||||||
that base and fails if the base disappears; it is not a frozen copy. Promptkit
|
|
||||||
tests the catalog versions selected in its module graph. Independently advancing
|
|
||||||
a catalog dependency can remove an inherited base and produce an untested
|
|
||||||
combination. Pinning the resolved module graph preserves the embedded data for
|
|
||||||
a build, but cannot preserve provider availability. Running binaries neither
|
|
||||||
download catalog updates nor automatically replace withdrawn models. See the
|
|
||||||
[release policy](../policy/release.md#catalog-profile-compatibility) for the exact
|
|
||||||
cross-version guarantees.
|
|
||||||
|
|
||||||
### Alias A Built-In Profile
|
|
||||||
|
|
||||||
Give an application-owned profile ID a built-in base when prompts should select
|
|
||||||
the application ID while inheriting the built-in target. The child can override
|
|
||||||
only the setting it owns:
|
|
||||||
|
|
||||||
```go
|
|
||||||
profile := promptkit.ProfileSource("application profiles", map[string]promptkit.ProfileConfig{
|
|
||||||
"weather-light": {
|
|
||||||
Extends: &standardID,
|
|
||||||
ReasoningEffort: &high,
|
|
||||||
},
|
|
||||||
})
|
|
||||||
```
|
|
||||||
|
|
||||||
Place `profile` in a ConfigKit underlay, with `standardID` set to
|
|
||||||
`"promptkit-openrouter-standard"` and `high` to `"high"`. Select
|
|
||||||
`weather-light` in a prompt or `RunRequest.ProfileID`; it remains the
|
|
||||||
reported selected profile. Definition IDs and inheritance references are exact
|
|
||||||
keys. If the base is an external profile, apply the volatility guidance
|
|
||||||
above when deciding whether to use an application-owned complete definition
|
|
||||||
instead.
|
|
||||||
|
|
||||||
### Use The Rakestrawhome Built-In Profile
|
|
||||||
|
|
||||||
Set `RAKESTRAWHOME_INFERENCE_API_KEY` in the application environment, then
|
|
||||||
select `rakestrawhome-gemma-4-31b` as an ordinary profile ID. For example, a
|
|
||||||
prepared result identifies the selected built-in through
|
|
||||||
`BackendRakestrawHome`:
|
|
||||||
|
|
||||||
```go
|
|
||||||
prepared, err := engine.Prepare(ctx, promptkit.RunRequest{
|
|
||||||
PromptID: "meeting.summary",
|
|
||||||
ProfileID: "rakestrawhome-gemma-4-31b",
|
|
||||||
Inputs: inputs,
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
if prepared.SelectedBackendID != promptkit.BackendRakestrawHome {
|
|
||||||
return fmt.Errorf("unexpected backend %q", prepared.SelectedBackendID)
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
The maintained catalog supplies this backend, and callers may overlay its
|
|
||||||
effective configuration through a later ConfigKit source. Direct request credentials
|
|
||||||
and runtime endpoint overrides remain supported under their ordinary GoDoc and
|
|
||||||
format contracts.
|
|
||||||
|
|
||||||
### Inspect A Profile Before Prompt Work
|
### Inspect A Profile Before Prompt Work
|
||||||
|
|
||||||
@@ -616,8 +739,8 @@ it and shared backend identity or capacity policy is unnecessary:
|
|||||||
|
|
||||||
```go
|
```go
|
||||||
endpoint, model := "http://localhost:8000/v1", "example-model"
|
endpoint, model := "http://localhost:8000/v1", "example-model"
|
||||||
profile := promptkit.ProfileSource("local profile", map[string]promptkit.ProfileConfig{
|
profile := promptkit.ProfileSource("local profile", []promptkit.ProfileConfig{
|
||||||
"local-summary": {Endpoint: &endpoint, Model: &model},
|
{ID: "local-summary", Endpoint: &endpoint, Model: &model},
|
||||||
})
|
})
|
||||||
// Add configkit.Input{Source: profile} to a caller underlay.
|
// Add configkit.Input{Source: profile} to a caller underlay.
|
||||||
```
|
```
|
||||||
@@ -632,11 +755,13 @@ identity, endpoint, and concurrency limit:
|
|||||||
|
|
||||||
```go
|
```go
|
||||||
backendID, model := promptkit.BackendLocal, "example-model"
|
backendID, model := promptkit.BackendLocal, "example-model"
|
||||||
backend := promptkit.BackendSource("local backend", map[string]promptkit.BackendConfig{
|
localBackend := promptkit.LocalBackend("http://localhost:8000/v1", 2)
|
||||||
backendID: promptkit.LocalBackend("http://localhost:8000/v1", 2),
|
localBackend.ID = backendID
|
||||||
|
backend := promptkit.BackendSource("local backend", []promptkit.BackendConfig{
|
||||||
|
localBackend,
|
||||||
})
|
})
|
||||||
profile := promptkit.ProfileSource("local profile", map[string]promptkit.ProfileConfig{
|
profile := promptkit.ProfileSource("local profile", []promptkit.ProfileConfig{
|
||||||
"local-summary": {Backend: &backendID, Model: &model},
|
{ID: "local-summary", Backend: &backendID, Model: &model},
|
||||||
})
|
})
|
||||||
// Add both sources as inputs in a caller underlay.
|
// Add both sources as inputs in a caller underlay.
|
||||||
```
|
```
|
||||||
@@ -647,13 +772,14 @@ capacity of 1024.
|
|||||||
|
|
||||||
#### Configure A Complete Backend
|
#### Configure A Complete Backend
|
||||||
|
|
||||||
Use a keyed `BackendConfig` value for authentication, extra request parameters, an
|
Use an identified `BackendConfig` value for authentication, extra request parameters, an
|
||||||
explicit queue capacity, a custom ID, or multiple local endpoints:
|
explicit queue capacity, a custom ID, or multiple local endpoints:
|
||||||
|
|
||||||
```go
|
```go
|
||||||
endpoint, keyName, limit, noWaiting := "http://gpu-host:8000/v1", "LOCAL_GPU_API_KEY", 2, 0
|
endpoint, keyName, limit, noWaiting := "http://gpu-host:8000/v1", "LOCAL_GPU_API_KEY", 2, 0
|
||||||
backend := promptkit.BackendSource("GPU backend", map[string]promptkit.BackendConfig{
|
backend := promptkit.BackendSource("GPU backend", []promptkit.BackendConfig{
|
||||||
"local-gpu": {
|
{
|
||||||
|
ID: "local-gpu",
|
||||||
Endpoint: &endpoint, APIKeyEnv: &keyName,
|
Endpoint: &endpoint, APIKeyEnv: &keyName,
|
||||||
ConcurrencyLimit: &limit, QueueCapacity: &noWaiting,
|
ConcurrencyLimit: &limit, QueueCapacity: &noWaiting,
|
||||||
ExtraParams: map[string]any{"provider_option": "enabled"},
|
ExtraParams: map[string]any{"provider_option": "enabled"},
|
||||||
@@ -662,7 +788,7 @@ backend := promptkit.BackendSource("GPU backend", map[string]promptkit.BackendCo
|
|||||||
```
|
```
|
||||||
|
|
||||||
Place `backend` in a caller underlay and select `"local-gpu"` from a
|
Place `backend` in a caller underlay and select `"local-gpu"` from a
|
||||||
`ProfileConfig.Backend` pointer or a keyed file profile. All backend
|
`ProfileConfig.Backend` pointer or an identified file profile. All backend
|
||||||
contributions use the same ConfigKit layering rules, including overlays of
|
contributions use the same ConfigKit layering rules, including overlays of
|
||||||
maintained definitions. The [`BackendConfig` and `LocalBackend` GoDoc](../../backends.go)
|
maintained definitions. The [`BackendConfig` and `LocalBackend` GoDoc](../../backends.go)
|
||||||
defines exact omission and construction behavior.
|
defines exact omission and construction behavior.
|
||||||
@@ -692,7 +818,7 @@ backend := promptkit.BackendConfig{
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
The pointer distinguishes an explicit zero from omission. Use keyed
|
The pointer distinguishes an explicit zero from omission. Use identified
|
||||||
`BackendConfig` literals inside `BackendSource` for programmatic definitions.
|
`BackendConfig` literals inside `BackendSource` for programmatic definitions.
|
||||||
Capacity belongs to one engine and the selected backend ID; endpoint-only
|
Capacity belongs to one engine and the selected backend ID; endpoint-only
|
||||||
profiles and custom backends without a configured limit remain unrestricted.
|
profiles and custom backends without a configured limit remain unrestricted.
|
||||||
|
|||||||
@@ -43,13 +43,13 @@ Before starting work:
|
|||||||
| Root public API | The [architecture policy](policy/architecture.md), [consumer guide](consumers/pkg-promptkit.md), [testing policy](policy/testing.md), and existing GoDoc. |
|
| Root public API | The [architecture policy](policy/architecture.md), [consumer guide](consumers/pkg-promptkit.md), [testing policy](policy/testing.md), and existing GoDoc. |
|
||||||
| Prompt, profile, or schema formats | The [framework format reference](formats.md), owning parser or validator package, and [documentation policy](policy/documentation.md). |
|
| Prompt, profile, or schema formats | The [framework format reference](formats.md), owning parser or validator package, and [documentation policy](policy/documentation.md). |
|
||||||
| Source loading or validation | The [framework format reference](formats.md), [internal source document](internal/sources.md), and owning package tests. |
|
| Source loading or validation | The [framework format reference](formats.md), [internal source document](internal/sources.md), and owning package tests. |
|
||||||
| Maintained external catalogs or built-ins | The [internal source document](internal/sources.md), [framework format reference](formats.md), [testing policy](policy/testing.md), both catalog module repositories, each catalog's release procedure, and the selected module versions in `go.mod`. |
|
| Caller-supplied configuration sources | The [internal source document](internal/sources.md), [framework format reference](formats.md), and [testing policy](policy/testing.md). |
|
||||||
| Model-client behavior | The [OpenAI-compatible integration contract](integrations/openai-compatible-chat.md), [internal model-client document](internal/llm.md), and owning package tests. |
|
| Model-client behavior | The [OpenAI-compatible integration contract](integrations/openai-compatible-chat.md), [internal model-client document](internal/llm.md), and owning package tests. |
|
||||||
| Internal package implementation | The [architecture policy](policy/architecture.md), [internal component overview](internal/overview.md), and focused internal document listed for that package. |
|
| Internal package implementation | The [architecture policy](policy/architecture.md), [internal component overview](internal/overview.md), and focused internal document listed for that package. |
|
||||||
| Tests or test fixtures | The [testing policy](policy/testing.md), owning package, and focused internal document listed by the component overview. |
|
| Tests or test fixtures | The [testing policy](policy/testing.md), owning package, and focused internal document listed by the component overview. |
|
||||||
| Maintained example | The [preparation](../examples/go-library/prepare/main.go), [execution](../examples/go-library/run/main.go), and [observation](../examples/go-library/observe/main.go) examples, [consumer guide](consumers/pkg-promptkit.md), [framework format reference](formats.md), and [documentation policy](policy/documentation.md). |
|
| Maintained example | The [preparation](../examples/go-library/prepare/main.go), [execution](../examples/go-library/run/main.go), and [observation](../examples/go-library/observe/main.go) examples, [consumer guide](consumers/pkg-promptkit.md), [framework format reference](formats.md), and [documentation policy](policy/documentation.md). |
|
||||||
| Documentation | The [documentation policy](policy/documentation.md) and canonical owner of every affected contract. |
|
| Documentation | The [documentation policy](policy/documentation.md) and canonical owner of every affected contract. |
|
||||||
| Licensing, dependencies/catalog updates, copied material, or attribution | The [OSS policy](policy/oss.md), [project grant](../COPYRIGHT), [license texts](../LICENSE), and [attribution entries](oss/attribution.md); inspect the selected upstream source's notices. |
|
| Licensing, dependencies, copied material, or attribution | The [OSS policy](policy/oss.md), [project grant](../COPYRIGHT), [license texts](../LICENSE), and [attribution entries](oss/attribution.md); inspect the selected upstream source's notices. |
|
||||||
| Release preparation or publication, including release notes | The [release policy](policy/release.md), [release procedure](release.md), and [OSS discoverability rules](policy/oss.md#discoverability). |
|
| Release preparation or publication, including release notes | The [release policy](policy/release.md), [release procedure](release.md), and [OSS discoverability rules](policy/oss.md#discoverability). |
|
||||||
|
|
||||||
For cross-cutting changes, follow every applicable row. Do not create
|
For cross-cutting changes, follow every applicable row. Do not create
|
||||||
@@ -67,7 +67,6 @@ the maintained examples when they are affected:
|
|||||||
go test ./...
|
go test ./...
|
||||||
go vet ./...
|
go vet ./...
|
||||||
gofmt -w path/to/changed.go
|
gofmt -w path/to/changed.go
|
||||||
python3 scripts/check-examples.py
|
|
||||||
git diff --check
|
git diff --check
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -77,12 +76,12 @@ describes its requirements and recovery. For an optional diagnostic of a
|
|||||||
committed candidate without publication, run `./scripts/releasekit.sh check
|
committed candidate without publication, run `./scripts/releasekit.sh check
|
||||||
VERSION`; this is not a required pre-publication step.
|
VERSION`; this is not a required pre-publication step.
|
||||||
|
|
||||||
The standalone `python3 scripts/check-examples.py` command checks semantic
|
The example workflows are covered by the Go suite; use
|
||||||
expectations for the three offline consumer examples. The focused
|
`go test ./examples/go-library/...` to run them separately during development.
|
||||||
`python3 scripts/test-release.py` command exercises the release tooling against
|
The focused `python3 scripts/test-release.py` command exercises the release
|
||||||
disposable local repositories; use it when changing that tooling, not as a
|
tooling against disposable local repositories; use it when changing that
|
||||||
recurring release gate. Tests and examples require no provider credentials or
|
tooling, not as a recurring release gate. Tests and examples require no provider
|
||||||
live inference calls.
|
credentials or live inference calls.
|
||||||
|
|
||||||
Ordinary validation can run on intended uncommitted work. Release validation
|
Ordinary validation can run on intended uncommitted work. Release validation
|
||||||
uses committed candidate contents and the selected local Go installation.
|
uses committed candidate contents and the selected local Go installation.
|
||||||
|
|||||||
282
docs/formats.md
282
docs/formats.md
@@ -6,38 +6,97 @@ This is the canonical reference for Promptkit's backend, profile, prompt, and
|
|||||||
schema definitions. The [Go consumer guide](consumers/pkg-promptkit.md) shows
|
schema definitions. The [Go consumer guide](consumers/pkg-promptkit.md) shows
|
||||||
how to select sources and use an engine; the
|
how to select sources and use an engine; the
|
||||||
[OpenAI-compatible integration contract](integrations/openai-compatible-chat.md)
|
[OpenAI-compatible integration contract](integrations/openai-compatible-chat.md)
|
||||||
owns outbound wire behavior. [ConfigKit](https://gitea.maximumdirect.net/eric/ConfigKit)
|
owns outbound wire behavior. [ConfigKit](https://forge.maximumdirect.net/base-layer/configkit/src/tag/v1.0.0/docs/config.md)
|
||||||
owns the generic YAML grammar, imports, layering, inheritance, and diagnostics.
|
owns the generic YAML grammar, imports, layering, inheritance, and diagnostics.
|
||||||
This reference describes what Promptkit does with the final effective values.
|
This reference describes what Promptkit does with the final effective values.
|
||||||
|
|
||||||
A configuration document has keyed top-level `backends`, `profiles`, and
|
A configuration document may contain top-level `backends`, `profiles`, and
|
||||||
`prompts` mappings. Their keys are literal IDs, not filename-derived identities.
|
`prompts` lists, plus a `collections` mapping of namespaced resource groups.
|
||||||
Prompt versions are a second keyed mapping. Keys and references must be
|
Each resource has an explicit literal `id`, not a filename-derived identity.
|
||||||
nonblank and remain exact: Promptkit does not trim or re-key them. Old embedded
|
IDs and references must be nonblank and remain exact: Promptkit does not trim or
|
||||||
`id`, `version`, and `base_profile` fields are invalid. Unknown fields are
|
re-key them. Unknown fields are errors. Promptkit installs no provider or
|
||||||
errors.
|
profile catalog; callers select the definitions they need.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
backends:
|
backends:
|
||||||
local:
|
- id: local
|
||||||
endpoint: http://localhost:8000/v1
|
endpoint: http://localhost:8000/v1
|
||||||
concurrency_limit: 2
|
concurrency_limit: 2
|
||||||
profiles:
|
profiles:
|
||||||
local-summary:
|
- id: local-summary
|
||||||
backend: local
|
backend: local
|
||||||
model: example-model
|
model: example-model
|
||||||
prompts:
|
prompts:
|
||||||
meeting.summary:
|
- id: meeting.summary
|
||||||
"1.0.0":
|
default_profile: local-summary
|
||||||
default_profile: local-summary
|
messages:
|
||||||
messages:
|
- role: user
|
||||||
- role: user
|
content: Summarize this note.
|
||||||
content: Summarize this note.
|
output:
|
||||||
output:
|
format: text
|
||||||
format: text
|
validation_mode: none
|
||||||
validation_mode: none
|
collections:
|
||||||
|
support:
|
||||||
|
release_version: "1.4.0"
|
||||||
|
backends:
|
||||||
|
- id: offline
|
||||||
|
endpoint: https://example.invalid/v1
|
||||||
|
profiles:
|
||||||
|
- id: base
|
||||||
|
backend: support/offline
|
||||||
|
model: offline-model
|
||||||
|
- id: fast
|
||||||
|
extends: {id: base}
|
||||||
|
timeout_seconds: 30
|
||||||
|
prompts:
|
||||||
|
- id: answer
|
||||||
|
default_profile: support/fast
|
||||||
|
messages:
|
||||||
|
- role: user
|
||||||
|
content: Answer the selected caller input.
|
||||||
|
output:
|
||||||
|
format: text
|
||||||
|
validation_mode: none
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Source Headers, Collections, And Resource IDs
|
||||||
|
|
||||||
|
An input may omit a source header. When present, the source-root `version` is
|
||||||
|
reserved for ConfigKit's specification header and accepts only the exact string
|
||||||
|
`"2"` or strict decimal integer `2`; null and other values are invalid. This
|
||||||
|
header is distinct from a collection's `release_version` and ConfigKit's own
|
||||||
|
software version. ConfigKit checks and consumes accepted headers on non-main
|
||||||
|
inputs; a declaration on the main input remains visible in explicit
|
||||||
|
configuration inspection. Headerless inputs still undergo ordinary final-value
|
||||||
|
validation. ConfigKit owns generic import and source-history behavior.
|
||||||
|
For a standalone prompt item, a root `version` is only a source header, not
|
||||||
|
prompt metadata.
|
||||||
|
|
||||||
|
The root resource lists contain unqualified IDs. Each `collections` entry
|
||||||
|
has a namespace key and may contain `release_version` plus the same three
|
||||||
|
resource lists. Collection resource IDs are local keys; their runtime IDs
|
||||||
|
are `<namespace>/<local-key>`. Root and collection keys may be the same. A
|
||||||
|
namespace and local key must be nonblank and slash-free, and references must
|
||||||
|
name their intended exact ID; mounting a source does not rewrite references.
|
||||||
|
For example, the `support/fast` profile above stores `support/offline` as its
|
||||||
|
backend ID. `extends: {id: base}` refers to a sibling in the same resource
|
||||||
|
list. It is not a qualified or cross-collection reference.
|
||||||
|
|
||||||
|
`release_version` is an optional opaque collection label. Absent or null means
|
||||||
|
no label; an explicitly empty string is retained. It does not select a resource
|
||||||
|
or change execution. Runtime lookups
|
||||||
|
use the captured effective resource indexes. `InspectConfiguration` is an
|
||||||
|
explicit operator view of composed settings and provenance. Normalization and
|
||||||
|
defaults appear in Promptkit's interpreted execution views, not as changes to
|
||||||
|
that composed tree. Source history is not a second runtime resolver, and the
|
||||||
|
retained effective shape is not flattened or rewritten into those indexes.
|
||||||
|
|
||||||
|
For examples of explicitly selecting native collection inputs and inspecting
|
||||||
|
inventories, see the [consumer guide](consumers/pkg-promptkit.md) and its
|
||||||
|
[maintained preparation example](../examples/go-library/prepare/main.go). For
|
||||||
|
breaking identity and prompt-selection changes, see the
|
||||||
|
[configuration migration guide](consumers/configuration-migration.md).
|
||||||
|
|
||||||
Every effective backend, profile, and prompt definition is validated when
|
Every effective backend, profile, and prompt definition is validated when
|
||||||
`NewEngine` constructs the engine, even if it is never selected. A profile may
|
`NewEngine` constructs the engine, even if it is never selected. A profile may
|
||||||
be partial: an endpoint and model need only be complete after request overrides
|
be partial: an endpoint and model need only be complete after request overrides
|
||||||
@@ -52,36 +111,35 @@ Schema and request artifact reads still happen during preparation. Use
|
|||||||
`InspectConfiguration` for an explicit effective-configuration or provenance
|
`InspectConfiguration` for an explicit effective-configuration or provenance
|
||||||
report, `InspectProfile` for backend-completed profile settings, and preparation
|
report, `InspectProfile` for backend-completed profile settings, and preparation
|
||||||
for request-specific rendered details. For identity discovery before inspection,
|
for request-specific rendered details. For identity discovery before inspection,
|
||||||
see the consumer guide's [profile and prompt listing](consumers/pkg-promptkit.md#discover-available-profiles-and-prompts).
|
see the consumer guide's [resource and collection listing](consumers/pkg-promptkit.md#discover-available-resources-and-collections).
|
||||||
|
|
||||||
## Prompt Definitions
|
## Prompt Definitions
|
||||||
|
|
||||||
The `prompts` mapping selects a literal prompt ID, then a string version key:
|
The `prompts` list contains definitions selected by their literal IDs:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
prompts:
|
prompts:
|
||||||
meeting.summary:
|
- id: meeting.summary
|
||||||
"1.0.0":
|
default_profile: local-summary
|
||||||
default_profile: local-summary
|
description: Summarize a synthetic meeting note.
|
||||||
description: Summarize a synthetic meeting note.
|
session_id: '{{.session}}'
|
||||||
session_id: '{{.session}}'
|
inputs:
|
||||||
inputs:
|
- name: note
|
||||||
- name: note
|
required: true
|
||||||
required: true
|
content_type: text/plain
|
||||||
content_type: text/plain
|
description: Meeting note to summarize.
|
||||||
description: Meeting note to summarize.
|
messages:
|
||||||
messages:
|
- role: system
|
||||||
- role: system
|
content: Return a concise summary.
|
||||||
content: Return a concise summary.
|
cache_control:
|
||||||
cache_control:
|
type: ephemeral
|
||||||
type: ephemeral
|
ttl: 1h
|
||||||
ttl: 1h
|
- role: user
|
||||||
- role: user
|
content_file: ./summary.user.md
|
||||||
content_file: ./summary.user.md
|
output:
|
||||||
output:
|
format: markdown
|
||||||
format: markdown
|
validation_mode: basic
|
||||||
validation_mode: basic
|
repair_attempts: 0
|
||||||
repair_attempts: 0
|
|
||||||
```
|
```
|
||||||
|
|
||||||
`messages` must be nonempty and `output` must be a valid mapping. Optional
|
`messages` must be nonempty and `output` must be a valid mapping. Optional
|
||||||
@@ -89,9 +147,8 @@ prompts:
|
|||||||
fields may be absent or cleared with null where appropriate. A null whole
|
fields may be absent or cleared with null where appropriate. A null whole
|
||||||
definition, required role, output format, or validation mode is invalid.
|
definition, required role, output format, or validation mode is invalid.
|
||||||
`required` and `repair_attempts` default to false and zero, respectively, and
|
`required` and `repair_attempts` default to false and zero, respectively, and
|
||||||
are not nullable. A request that omits a prompt version succeeds only if that
|
are not nullable. `InspectPrompt` selects the same captured definition without
|
||||||
prompt ID has exactly one effective version. `InspectPrompt` selects from the
|
rendering or resolving a profile.
|
||||||
same captured definitions without rendering or resolving a profile.
|
|
||||||
|
|
||||||
### Inputs
|
### Inputs
|
||||||
|
|
||||||
@@ -156,36 +213,74 @@ last candidate and its failed validation result. Operational errors remain
|
|||||||
errors. A request-level `OutputContract` replaces the whole configured one,
|
errors. A request-level `OutputContract` replaces the whole configured one,
|
||||||
not individual fields; an empty request format defaults to `text`.
|
not individual fields; an empty request format defaults to `text`.
|
||||||
|
|
||||||
## Built-In Backends
|
## Backend Definitions
|
||||||
|
|
||||||
The selected catalog modules contribute these backend definitions as the
|
Backend definitions are supplied through caller-selected configuration
|
||||||
earliest underlay. Their settings can be overlaid by caller sources; these IDs
|
sources. The conventional backend IDs are names only; PromptKit does not
|
||||||
are not reserved against configuration changes.
|
install definitions for them.
|
||||||
|
|
||||||
| ID | Catalog endpoint | API-key environment name | Active generation limit |
|
|
||||||
| --- | --- | --- | ---: |
|
|
||||||
| `openrouter` | `https://openrouter.ai/api/v1` | `OPENROUTER_API_KEY` | 16 |
|
|
||||||
| `rakestrawhome` | `https://inference.ai.rakestrawhome.com/v1` | `RAKESTRAWHOME_INFERENCE_API_KEY` | 4 |
|
|
||||||
|
|
||||||
A backend definition may have `endpoint`, `api_key_env`,
|
A backend definition may have `endpoint`, `api_key_env`,
|
||||||
`concurrency_limit`, `queue_capacity`, and `extra_params`. The final endpoint
|
`concurrency_limit`, `queue_capacity`, `extra_params`, and `smoke_tests`. The
|
||||||
is required and must be an absolute HTTP(S) URL with a host, no user
|
final endpoint is required and must be an absolute HTTP(S) URL with a host, no
|
||||||
information, query, or fragment. An omitted or null API-key environment name
|
user information, query, or fragment. An omitted or null API-key environment
|
||||||
means no lookup. Omitted/null concurrency is zero (unlimited); a supplied
|
name means no lookup. Omitted/null concurrency is zero (unlimited); a supplied
|
||||||
negative value is invalid. For positive concurrency, omitted/null queue
|
negative value is invalid. For positive concurrency, omitted/null queue
|
||||||
capacity defaults to 1024. An explicit queue capacity, including zero,
|
capacity defaults to 1024. An explicit queue capacity, including zero,
|
||||||
requires positive concurrency and must be nonnegative. Unlimited concurrency
|
requires positive concurrency and must be nonnegative. Unlimited concurrency
|
||||||
has no queue. Provider maps contain JSON-compatible values; null entries are
|
has no queue. Provider maps contain JSON-compatible values; null entries are
|
||||||
ordinary JSON null. Unknown fields, including a raw `api_key`, fail.
|
ordinary JSON null. Unknown fields, including a raw `api_key`, fail.
|
||||||
|
|
||||||
|
`smoke_tests` is optional backend metadata for explicit diagnostic operations.
|
||||||
|
It may contain `default_profile`, `reachability`, and `authentication`:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
backends:
|
||||||
|
- id: openrouter
|
||||||
|
endpoint: https://openrouter.ai/api/v1
|
||||||
|
smoke_tests:
|
||||||
|
default_profile: application-profile
|
||||||
|
reachability:
|
||||||
|
endpoint: https://status.example/ready?check=1
|
||||||
|
authentication:
|
||||||
|
kind: openrouter_key
|
||||||
|
endpoint: https://openrouter.ai/api/v1/key
|
||||||
|
```
|
||||||
|
|
||||||
|
An omitted or null `smoke_tests` block disables these metadata defaults.
|
||||||
|
`default_profile` is preserved as an exact, nonblank profile ID; its existence
|
||||||
|
is checked only if an inference diagnostic selects that default. Omitted/null
|
||||||
|
`default_profile` means there is no inference default. Omitted/null
|
||||||
|
`reachability` or its endpoint uses the effective backend endpoint. An explicit
|
||||||
|
reachability endpoint is trimmed and must be an absolute HTTP(S) URL with a
|
||||||
|
host; unlike the backend base endpoint, its path and query are allowed. Null
|
||||||
|
means fallback, while an explicit blank value is invalid.
|
||||||
|
|
||||||
|
Omitted/null `authentication` means no authentication adapter is declared. A
|
||||||
|
non-null object requires `kind`, which is trimmed and case-normalized; the
|
||||||
|
recognized values are `none` and `openrouter_key`. Its omitted/null endpoint
|
||||||
|
uses the adapter's backend-relative destination (`openrouter_key` appends
|
||||||
|
`/key` to the effective backend base); an explicit endpoint follows the same
|
||||||
|
full-URL rules as reachability. `none` declares authentication inapplicable.
|
||||||
|
These values are configuration only: engine construction does not contact a
|
||||||
|
backend.
|
||||||
|
|
||||||
|
These fields are resolved through the ordinary ConfigKit source layers before
|
||||||
|
Promptkit validates the final effective values. Sibling inheritance can overlay
|
||||||
|
individual nested fields; a later same-ID resource replaces the whole record.
|
||||||
|
An explicit null can clear the whole `smoke_tests` block or one of its nested
|
||||||
|
objects. An endpoint set to null uses
|
||||||
|
its documented fallback, while an explicit blank endpoint is invalid. The
|
||||||
|
metadata does not change ordinary generation credential requirements or
|
||||||
|
provider settings.
|
||||||
|
|
||||||
## Profile Definitions
|
## Profile Definitions
|
||||||
|
|
||||||
Profiles are keyed by literal ID and may inherit a named parent with
|
Profiles have literal IDs and may inherit a sibling parent with
|
||||||
`extends`:
|
`extends`:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
profiles:
|
profiles:
|
||||||
local-summary:
|
- id: local-summary
|
||||||
backend: local
|
backend: local
|
||||||
model: example-model
|
model: example-model
|
||||||
temperature: 0.2
|
temperature: 0.2
|
||||||
@@ -193,8 +288,8 @@ profiles:
|
|||||||
timeout_seconds: 90
|
timeout_seconds: 90
|
||||||
extra_params:
|
extra_params:
|
||||||
provider_option: enabled
|
provider_option: enabled
|
||||||
local-summary-fast:
|
- id: local-summary-fast
|
||||||
extends: local-summary
|
extends: {id: local-summary}
|
||||||
timeout_seconds: 30
|
timeout_seconds: 30
|
||||||
reasoning_effort: low
|
reasoning_effort: low
|
||||||
```
|
```
|
||||||
@@ -238,56 +333,37 @@ does not disable the caller context or HTTP transport timeout.
|
|||||||
|
|
||||||
### Source And Profile Precedence
|
### Source And Profile Precedence
|
||||||
|
|
||||||
`NewEngine` composes catalog definitions first, Promptkit-owned definitions
|
`NewEngine` composes caller underlays in their given order, followed by an
|
||||||
next, then caller underlays in their given order, with an optional main input
|
optional main input. Later layers overlay earlier ones. Inputs within one
|
||||||
last. Later tiers overlay earlier ones. Inputs within one underlay group are
|
underlay group are strictly composed: conflicting contributions are errors,
|
||||||
strictly composed: conflicting contributions are errors, not priority
|
not priority signals. The directory helpers discover `.yaml` and `.yml` files recursively
|
||||||
signals. The directory helpers discover `.yaml` and `.yml` files recursively
|
|
||||||
in sorted order, but that order does not give one file higher precedence.
|
in sorted order, but that order does not give one file higher precedence.
|
||||||
An explicitly selected missing/unreadable root fails; an empty root contributes
|
An explicitly selected missing/unreadable root fails; an empty root contributes
|
||||||
nothing. Imports are disabled by these helpers unless the caller enables them
|
nothing. Imports are disabled by these helpers unless the caller enables them
|
||||||
on an input. Single files can use ConfigKit inputs directly.
|
on an input. Single files can use ConfigKit inputs directly.
|
||||||
|
|
||||||
Backends, profiles, and prompts all follow these same source rules. A later
|
Root backends, profiles, and prompts, as well as collection declarations and
|
||||||
profile or backend can change individual fields of a lower definition. A
|
their resource lists, follow these same source rules. `CollectionInput`
|
||||||
request `ProfileID` takes precedence over a prompt `default_profile`; if
|
mounts one explicitly selected source at a collection destination and enables
|
||||||
|
ConfigKit imports for that input; it does not discover or select sources.
|
||||||
|
A later same-ID record replaces the lower definition in full. Use a distinct
|
||||||
|
inherited sibling when a variant should retain its parent's fields.
|
||||||
|
A request `ProfileID` takes precedence over a prompt `default_profile`; if
|
||||||
neither is selected, preparation fails. Exact profile inspection selects one
|
neither is selected, preparation fails. Exact profile inspection selects one
|
||||||
explicit ID and does not consult a prompt default.
|
explicit ID and does not consult a prompt default.
|
||||||
|
|
||||||
### Profile Inheritance
|
### Resource Inheritance
|
||||||
|
|
||||||
ConfigKit resolves `extends` on effective profile definitions. One profile
|
ConfigKit resolves `extends: {id: parent}` for backends, profiles, and prompts.
|
||||||
may inherit another keyed profile; presence, explicit null, and recursively
|
Each child inherits a surviving sibling in the same root or collection list;
|
||||||
merged maps determine the final fields. References are literal IDs, including
|
collection inheritance cannot cross namespaces. Parents are ordinary validated
|
||||||
IDs containing punctuation. There is no Promptkit-specific depth limit or
|
resources, and profiles may remain partial until request completion. Presence, explicit
|
||||||
second base-chain resolver. Missing references and cycles fail at construction.
|
null, and recursively merged maps determine the final fields. Other resource
|
||||||
For generic inheritance and layer mechanics, consult
|
references are exact IDs and use their qualified form when they select a
|
||||||
[ConfigKit](https://gitea.maximumdirect.net/eric/ConfigKit).
|
collection resource. There is no Promptkit-specific depth limit or second
|
||||||
|
base-chain resolver. Missing references and cycles fail at construction. For
|
||||||
## Built-In Profile Catalog
|
generic inheritance and layer mechanics, consult
|
||||||
|
[ConfigKit](https://forge.maximumdirect.net/base-layer/configkit/src/tag/v1.0.0/docs/config.md).
|
||||||
Promptkit contributes two opt-in definitions; neither is selected by default:
|
|
||||||
|
|
||||||
| ID | Current definition |
|
|
||||||
| --- | --- |
|
|
||||||
| `promptkit-openrouter-standard` | Extends the selected OpenRouter catalog's `gemini-flash-latest` profile. |
|
|
||||||
| `promptkit-openrouter-auto` | Selects backend `openrouter` and model `openrouter/auto`. |
|
|
||||||
|
|
||||||
Select one through request `ProfileID` or prompt `default_profile`.
|
|
||||||
Caller layers may overlay these definitions or their catalog bases. The
|
|
||||||
[release policy](policy/release.md#catalog-profile-compatibility) owns their
|
|
||||||
cross-version compatibility boundary.
|
|
||||||
|
|
||||||
## External Profile Inventories
|
|
||||||
|
|
||||||
The selected catalog modules, not this document, own their profile inventories:
|
|
||||||
|
|
||||||
- [OpenRouter catalog v3.20260930.0 profiles](https://gitea.maximumdirect.net/eric/promptkit-backend-openrouter/src/tag/v3.20260930.0/catalog/profiles)
|
|
||||||
- [Rakestrawhome catalog v3.20260930.0 profiles](https://gitea.maximumdirect.net/eric/promptkit-backend-rakestrawhome/src/tag/v3.20260930.0/catalog/profiles)
|
|
||||||
|
|
||||||
These are tested local data, not a promise of live provider availability.
|
|
||||||
The [release policy](policy/release.md#catalog-profile-compatibility) owns
|
|
||||||
the compatibility boundary.
|
|
||||||
|
|
||||||
## Schemas
|
## Schemas
|
||||||
|
|
||||||
|
|||||||
@@ -45,6 +45,45 @@ precedence over the backend default. Only the name reaches prepared metadata;
|
|||||||
the environment value is read just before the provider call and is never added
|
the environment value is read just before the provider call and is never added
|
||||||
to the JSON body.
|
to the JSON body.
|
||||||
|
|
||||||
|
## Explicit Smoke Diagnostics
|
||||||
|
|
||||||
|
Promptkit's explicit smoke diagnostics are separate consumer operations; they
|
||||||
|
are not part of ordinary `Run`, the offline examples, or release validation.
|
||||||
|
With the built-in client, inference diagnostics use the same configured client
|
||||||
|
and `/chat/completions` request as generation. Their content cases are private
|
||||||
|
to Promptkit and are not application prompt, schema, or provider protocol
|
||||||
|
extensions. The public
|
||||||
|
[`Engine.SmokeTest` GoDoc](../../smoke_diagnostics.go) owns request selection,
|
||||||
|
report facts, and injected-client behavior.
|
||||||
|
|
||||||
|
HTTP-only diagnostics use the configured built-in HTTP client. Reachability is
|
||||||
|
one unauthenticated `GET` to the selected diagnostic URL; an observed response
|
||||||
|
counts as reachable even when its status is non-2xx. Authentication behavior
|
||||||
|
is selected from backend metadata, not inferred from the host. The
|
||||||
|
`openrouter_key` adapter makes one `GET` to `/key` relative to the effective
|
||||||
|
backend base, unless configuration supplies a full diagnostic endpoint (see
|
||||||
|
the [backend format reference](../formats.md#backend-definitions)). It may send
|
||||||
|
the available bearer credential, but can dispatch without one. A 401 is
|
||||||
|
recognized as rejection. A 200 is recognized as acceptance only when its JSON
|
||||||
|
object has a `data` object containing string `label`, Boolean `is_free_tier`,
|
||||||
|
and numeric `usage`; unrelated fields and account limits are ignored. This is
|
||||||
|
only a minimal identifying subset of OpenRouter's documented
|
||||||
|
[current-key response](https://github.com/OpenRouterTeam/docs/blob/main/api_reference/limits.mdx#checking-your-limits),
|
||||||
|
not validation of the full account document. Other statuses and unrecognized
|
||||||
|
200 responses do not establish acceptance.
|
||||||
|
|
||||||
|
Diagnostic HTTP evidence describes the last request observed at Promptkit's
|
||||||
|
RoundTripper boundary and any response associated with it. It includes the
|
||||||
|
selected destination without URL user information, response status, and
|
||||||
|
credential presence when observed. Redirects can change the last observed
|
||||||
|
destination or strip credentials. This evidence does not prove that bytes
|
||||||
|
reached a peer or reveal dispatch hidden inside a custom transport. Diagnostic
|
||||||
|
reports do not retain headers, credentials, provider
|
||||||
|
bodies, or generated text. A consumer-injected `LLMClient` can support inference
|
||||||
|
diagnostics, but does not establish HTTP status, destination, reachability, or
|
||||||
|
upstream credential-supply facts; Promptkit does not fall back to a built-in
|
||||||
|
transport for HTTP-only diagnostics.
|
||||||
|
|
||||||
## Request Body
|
## Request Body
|
||||||
|
|
||||||
The request body always contains `model` and `messages`. The execution
|
The request body always contains `model` and `messages`. The execution
|
||||||
|
|||||||
@@ -88,6 +88,17 @@ release, including canceled acquisition without dispatch. A retry wait holds
|
|||||||
the logical admission lease but no active permit. Observer callbacks must not
|
the logical admission lease but no active permit. Observer callbacks must not
|
||||||
block on work that requires the same run's admission slot.
|
block on work that requires the same run's admission slot.
|
||||||
|
|
||||||
|
## Smoke-Test Capacity
|
||||||
|
|
||||||
|
The engine's smoke tester shares this manager and generation coordinator with
|
||||||
|
the ordinary runner. Inference diagnostics reserve the same logical admission
|
||||||
|
slot and acquire the same backend-scoped active permits for actual model
|
||||||
|
attempts, including retries. They therefore participate in the same configured
|
||||||
|
backend limits as `Run`. Reachability and authentication HTTP probes do not
|
||||||
|
enter generation admission or consume active permits. The public
|
||||||
|
[`Engine.SmokeTest` GoDoc](../../smoke_diagnostics.go) owns the caller-visible
|
||||||
|
operation and injected-client limits.
|
||||||
|
|
||||||
## Cancellation And Release
|
## Cancellation And Release
|
||||||
|
|
||||||
Admission checks the caller context before reserving a slot. A call canceled
|
Admission checks the caller context before reserving a slot. A call canceled
|
||||||
@@ -127,4 +138,7 @@ cover shared and independent backend pools during retry and repair. The
|
|||||||
own the public prepared-capacity boundary. The
|
own the public prepared-capacity boundary. The
|
||||||
[root error-boundary tests](../../errors_internal_test.go) own preservation of
|
[root error-boundary tests](../../errors_internal_test.go) own preservation of
|
||||||
the public generation category and context identity when generation is
|
the public generation category and context identity when generation is
|
||||||
canceled.
|
canceled. The assembled
|
||||||
|
[smoke diagnostic contract tests](../../smoke_integration_contract_test.go)
|
||||||
|
verify that inference diagnostics share the engine's Run admission and recover
|
||||||
|
capacity after cancellation or failure.
|
||||||
|
|||||||
@@ -41,9 +41,22 @@ original error chain. This keeps injected attempt classifications consistent
|
|||||||
with terminal observations without parsing diagnostic text or retrying injected
|
with terminal observations without parsing diagnostic text or retrying injected
|
||||||
clients.
|
clients.
|
||||||
|
|
||||||
|
The diagnostic path uses the same private attempt and retry implementation as
|
||||||
|
ordinary generation. It retains invocation-local transport, response,
|
||||||
|
generation, usage, capacity-wait, and retry-delay evidence before normal
|
||||||
|
result-discard and cancellation checks. Built-in preparation also supplies its
|
||||||
|
frozen request URL to the evidence path before attempts begin; injected
|
||||||
|
generation has no equivalent HTTP destination. This evidence is returned to
|
||||||
|
diagnostic orchestration; it is not added to public `ExecutionEvent` values or ordinary
|
||||||
|
observer accounting. The [model-client document](llm.md) describes the
|
||||||
|
transport-observation boundary, and the root
|
||||||
|
[`SmokeTestReport` GoDoc](../../smoke_diagnostics.go) owns report semantics.
|
||||||
|
|
||||||
Focused coordinator tests use controlled transport and wait functions. They
|
Focused coordinator tests use controlled transport and wait functions. They
|
||||||
cover eligibility, exhaustion, cancellation, backoff, request freezing, permit
|
cover eligibility, exhaustion, cancellation, backoff, request freezing, permit
|
||||||
release, and the injected-client path. The capacity manager tests own permit
|
release, and the injected-client path. The
|
||||||
|
[evidence tests](../../internal/generation/evidence_test.go) own diagnostic
|
||||||
|
attempt retention and retry evidence. The capacity manager tests own permit
|
||||||
acquisition and idempotent release. Public
|
acquisition and idempotent release. Public
|
||||||
[integration tests](../../reliable_execution_contract_test.go) cover retry,
|
[integration tests](../../reliable_execution_contract_test.go) cover retry,
|
||||||
repair, observation, frozen prepared execution, and shared-backend behavior
|
repair, observation, frozen prepared execution, and shared-backend behavior
|
||||||
|
|||||||
@@ -59,6 +59,33 @@ This client does not schedule retries; the [generation coordinator](generation.m
|
|||||||
does so around its prepared attempts. The client has no tool-call support,
|
does so around its prepared attempts. The client has no tool-call support,
|
||||||
provider catalog, inbound HTTP behavior, or durable session store.
|
provider catalog, inbound HTTP behavior, or durable session store.
|
||||||
|
|
||||||
|
## Diagnostic HTTP Evidence
|
||||||
|
|
||||||
|
Built-in diagnostics wrap the selected HTTP client's `RoundTripper` for one
|
||||||
|
invocation using a shallow client copy, preserving its timeout, redirect policy,
|
||||||
|
cookie jar, and underlying transport without mutating the configured client.
|
||||||
|
Evidence distinguishes a diagnostic dispatch invocation from an observed
|
||||||
|
request and response. A newly observed request replaces the previous
|
||||||
|
destination-specific response evidence, so redirects retain only the last
|
||||||
|
observed hop. A response is recorded before envelope decoding or later context
|
||||||
|
checks can discard a generation result.
|
||||||
|
|
||||||
|
The collector keeps only the last observed destination (without URL user
|
||||||
|
information), status, credential-presence, response-availability, decoded
|
||||||
|
generation, and presence-aware usage facts needed by the diagnostic. It does
|
||||||
|
not retain headers, credentials, raw request or response bodies, or a redirect
|
||||||
|
trace. These are observations at Promptkit's RoundTripper boundary, not proof
|
||||||
|
that bytes reached a peer or that a custom transport did no hidden dispatch.
|
||||||
|
Reachability and named authentication probes use the same configured built-in
|
||||||
|
client but discard their response bodies after local recognition. The
|
||||||
|
[integration contract](../integrations/openai-compatible-chat.md#explicit-smoke-diagnostics)
|
||||||
|
owns their observable HTTP semantics.
|
||||||
|
|
||||||
|
An injected `LLMClient` does not pass through this HTTP boundary. Its returned
|
||||||
|
response can establish response and inference facts, but not an HTTP
|
||||||
|
destination, status, reachability, or upstream credential-supply fact. The
|
||||||
|
facade does not silently install a built-in transport for those diagnostics.
|
||||||
|
|
||||||
## Prepared Generation
|
## Prepared Generation
|
||||||
|
|
||||||
For [`RunPrepared`](../../engine.go), the runner supplies the model client with
|
For [`RunPrepared`](../../engine.go), the runner supplies the model client with
|
||||||
@@ -137,7 +164,10 @@ own configuration, client cloning, deterministic deadline precedence,
|
|||||||
authentication, request and response mapping, malformed data, error identity,
|
authentication, request and response mapping, malformed data, error identity,
|
||||||
cancellation, endpoint selection and composition, pre-transport rejection, and
|
cancellation, endpoint selection and composition, pre-transport rejection, and
|
||||||
bounded single-document successful-response framing, closure, and
|
bounded single-document successful-response framing, closure, and
|
||||||
response-body suppression. The focused
|
response-body suppression. The [HTTP evidence tests](../../internal/llm/http_evidence_test.go)
|
||||||
|
own invocation-local last-hop request/response facts, while the
|
||||||
|
[prepared-generation evidence tests](../../internal/llm/prepared_generation_evidence_test.go)
|
||||||
|
own retention across decoding and cancellation. The focused
|
||||||
[provider HTTP error tests](../../internal/llm/provider_http_error_test.go)
|
[provider HTTP error tests](../../internal/llm/provider_http_error_test.go)
|
||||||
own envelope parsing, normalization, and bounded-reader cases; their
|
own envelope parsing, normalization, and bounded-reader cases; their
|
||||||
[transport tests](../../internal/llm/provider_http_error_transport_test.go)
|
[transport tests](../../internal/llm/provider_http_error_transport_test.go)
|
||||||
|
|||||||
@@ -23,6 +23,9 @@ callback. The caller supplies normalized failure metadata; the recorder never
|
|||||||
parses an error string or receives provider bodies, credentials, headers, or
|
parses an error string or receives provider bodies, credentials, headers, or
|
||||||
other content. Events are values with no mutable containers. Callback panics
|
other content. Events are values with no mutable containers. Callback panics
|
||||||
propagate to the caller.
|
propagate to the caller.
|
||||||
|
Resolved prompt and profile IDs are the exact runtime identities selected for
|
||||||
|
the invocation, including namespace qualification when supplied by an engine
|
||||||
|
view.
|
||||||
Per-operation callbacks are ordered and synchronous; different operations may
|
Per-operation callbacks are ordered and synchronous; different operations may
|
||||||
invoke the same callback concurrently. The recorder marks each measured phase's
|
invoke the same callback concurrently. The recorder marks each measured phase's
|
||||||
end before delivery, so callback work does not inflate provider duration.
|
end before delivery, so callback work does not inflate provider duration.
|
||||||
@@ -41,6 +44,11 @@ attempts above the first in a generation, and repair generations with at least
|
|||||||
one dispatch. A terminal event is an aggregate and must not be added to its
|
one dispatch. A terminal event is an aggregate and must not be added to its
|
||||||
attempt events.
|
attempt events.
|
||||||
|
|
||||||
|
Smoke diagnostics mask inherited execution-recorder state while invoking
|
||||||
|
generation or HTTP collaborators. Their private attempt evidence is assembled
|
||||||
|
into a `SmokeTestReport`; it does not create ordinary run events or enter an
|
||||||
|
enclosing run's observation totals.
|
||||||
|
|
||||||
The [recorder tests](../../internal/observation/recorder_test.go) own usage
|
The [recorder tests](../../internal/observation/recorder_test.go) own usage
|
||||||
presence, phase sums, event ordering, empty-run accounting, identity snapshots,
|
presence, phase sums, event ordering, empty-run accounting, identity snapshots,
|
||||||
and callback panic behavior. The [generation coordinator](generation.md) owns
|
and callback panic behavior. The [generation coordinator](generation.md) owns
|
||||||
|
|||||||
@@ -11,17 +11,16 @@ contributor workflow and validation.
|
|||||||
|
|
||||||
| Component | Implemented responsibility | References |
|
| Component | Implemented responsibility | References |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| Root `promptkit` package | Provides the supported engine facade, ConfigKit source helpers, profile and backend mapping conveniences, injection options, public requests and results, prompt/profile/requirement inspection and identity listing, observation values, opaque prepared-execution handles, value conversion, redacted formatting, and typed capacity and generation error mapping. | [Package GoDoc](../../doc.go), [observations](../../observations.go), [prepared execution](../../prepared_execution.go), [backend API](../../backends.go), [engine facade](../../engine.go), [identity listing](../../listing.go), [requirement facade](../../requirements.go) |
|
| Root `promptkit` package | Provides the supported engine facade, ConfigKit source helpers, collection and resource mapping conveniences, injection options, public requests and results, prompt/profile/requirement inspection and identity inventories, concrete-request validation, explicit smoke diagnostics, observation values, opaque prepared-execution handles, value conversion, redacted formatting, and typed capacity and generation error mapping. | [Package GoDoc](../../doc.go), [observations](../../observations.go), [prepared execution](../../prepared_execution.go), [backend API](../../backends.go), [engine facade](../../engine.go), [smoke diagnostics](../../smoke_diagnostics.go), [identity listing](../../listing.go), [requirement facade](../../requirements.go) |
|
||||||
| `examples/go-library/prepare` | Demonstrates offline preparation and explicit configuration inspection with a prompt file, programmatic profile, and inline input. It is not a public library package. | [Example program](../../examples/go-library/prepare/main.go) |
|
| `examples/go-library/prepare` | Demonstrates offline preparation from two explicitly selected synthetic collections, source-relative imported content, a scoped view, filtered listings, and operator inventory. It is not a public library package. | [Example program](../../examples/go-library/prepare/main.go), [collection inputs](../../examples/go-library/prepare/collections/support/collection.yaml) |
|
||||||
| `examples/go-library/run` | Demonstrates an offline downstream consumer using a prompt file, programmatic profile, inline input, an injected deterministic model client, and `Run`. It is not a public library package. | [Example program](../../examples/go-library/run/main.go) |
|
| `examples/go-library/run` | Demonstrates an offline downstream consumer using a prompt file, programmatic profile, inline input, an injected deterministic model client, and `Run`. It is not a public library package. | [Example program](../../examples/go-library/run/main.go) |
|
||||||
| `examples/go-library/observe` | Demonstrates offline built-in HTTP retry and synchronous metadata observation across structured proposal and assessment runs using embedded sources, two profiles on one finite backend, and an application decision. It is not a public library package. | [Example program](../../examples/go-library/observe/main.go) |
|
| `examples/go-library/observe` | Demonstrates offline built-in HTTP retry and synchronous metadata observation across structured proposal and assessment runs using embedded sources, two profiles on one finite backend, and an application decision. It is not a public library package. | [Example program](../../examples/go-library/observe/main.go) |
|
||||||
| `internal/backend` | Holds a defensive, immutable lookup and capacity-policy index for final backend definitions validated by the configuration adapter. | [Backend registry](../../internal/backend/registry.go) |
|
| `internal/backend` | Holds a defensive, immutable lookup of final backend definitions, including diagnostic metadata, plus capacity policies validated by the configuration adapter. | [Backend registry](../../internal/backend/registry.go) |
|
||||||
| `internal/catalog` | Selects released keyed catalog assets and PromptKit-owned profile definitions as ConfigKit underlays; effective validation belongs to the configuration loader. | [Catalog adapter](../../internal/catalog/catalog.go), [internal sources](sources.md#profiles-and-built-ins) |
|
| `internal/configuration` | Loads root and namespaced collection resources through ConfigKit; records effective field presence, validates final values including exact references and optional diagnostic metadata, captures indexed prompt definitions and source-relative message content, compiled templates, input metadata snapshots, sorted backend/profile/prompt identities, resource namespace sets, effective collection declarations, backend and presence-aware profile snapshots, and the unchanged read-only inspection view. | [Typed loader](../../internal/configuration/load.go), [identity listing](../../internal/configuration/listing.go), [internal sources](sources.md#typed-configuration-loading) |
|
||||||
| `internal/configuration` | Loads keyed backend, profile, and prompt configuration through ConfigKit; records effective field presence, validates final values, captures indexed prompt definitions, referenced message content, compiled templates, input metadata snapshots, sorted identity-only profile and prompt inventories, backend and presence-aware profile snapshots, and an explicit read-only inspection view. | [Typed loader](../../internal/configuration/load.go), [identity listing](../../internal/configuration/listing.go), [internal sources](sources.md#typed-configuration-loading) |
|
|
||||||
| `internal/capacity` | Owns engine-local bounded execution admission and FIFO model-generation permits for limited backend IDs, including cancellation-safe waiter removal and client wrapping. | [Internal capacity management](capacity.md) |
|
| `internal/capacity` | Owns engine-local bounded execution admission and FIFO model-generation permits for limited backend IDs, including cancellation-safe waiter removal and client wrapping. | [Internal capacity management](capacity.md) |
|
||||||
| `internal/domain` | Defines internal framework values for requests, artifacts, prompt definitions, requirement inspection, profiles, execution targets, rendering, generation, and validation, and owns source-neutral invariants for shared execution settings, OpenAI-compatible base endpoints, session identifiers, and output contracts. Source parsing, required fields, other source-specific normalization, defaulting, and boundary-specific error classification remain with their callers. | [Domain declarations](../../internal/domain/domain.go), [requirement values](../../internal/domain/requirements.go), [endpoint invariant](../../internal/domain/endpoint.go) |
|
| `internal/domain` | Defines internal framework values for requests, artifacts, prompt definitions, requirement inspection, profiles, execution targets, rendering, generation, validation, and source-neutral smoke diagnostics, and owns source-neutral invariants for shared execution settings, OpenAI-compatible base endpoints, session identifiers, output contracts, and resource-identity syntax and qualification. Source parsing, required fields, other source-specific normalization, defaulting, and boundary-specific error classification remain with their callers. | [Domain declarations](../../internal/domain/domain.go), [requirement values](../../internal/domain/requirements.go), [endpoint invariant](../../internal/domain/endpoint.go) |
|
||||||
| `internal/engine` | Assembles selected catalog and caller configuration into one snapshot, then constructs capacity, rendering, validation, generation, repair, and the use-case runner for each engine. It delegates identity listing directly to the captured configuration inventory rather than the runner. | [Engine assembly](../../internal/engine/engine.go), [internal sources](sources.md#profiles-and-built-ins), [internal runner](runner.md) |
|
| `internal/engine` | Assembles caller-selected configuration into one snapshot, then constructs shared capacity, rendering, validation, generation, repair, the ordinary runner, and the smoke tester for each engine. Immutable namespace views share those collaborators and qualify caller-supplied execution, inspection, and diagnostic selections without rewriting captured references. Built-in engines provide the diagnostic HTTP collaborator; injected-client engines do not. It delegates identity listing directly to the captured configuration inventory rather than the runner. | [Engine assembly](../../internal/engine/engine.go), [internal sources](sources.md#typed-configuration-loading), [internal runner](runner.md) |
|
||||||
| `internal/generation` | Coordinates frozen built-in HTTP attempts and one-shot injected calls through active backend permits, including bounded status retries, cancellable backoff, and attempt observations. | [Internal generation coordination](generation.md) |
|
| `internal/generation` | Coordinates frozen built-in HTTP attempts and one-shot injected calls through active backend permits, including bounded status retries, cancellable backoff, ordinary attempt observations, and invocation-local evidence for diagnostics. | [Internal generation coordination](generation.md) |
|
||||||
| `internal/defaults` | Defines application-neutral framework constants and constructs the default execution target. It contains no CLI, server, or inbound HTTP limits. | [Framework defaults](../../internal/defaults/defaults.go) |
|
| `internal/defaults` | Defines application-neutral framework constants and constructs the default execution target. It contains no CLI, server, or inbound HTTP limits. | [Framework defaults](../../internal/defaults/defaults.go) |
|
||||||
| `internal/filecatalog` | Provides deterministic YAML discovery and path helpers for operating-system filesystems and `fs.FS` sources. | [File catalog](../../internal/filecatalog/catalog.go) |
|
| `internal/filecatalog` | Provides deterministic YAML discovery and path helpers for operating-system filesystems and `fs.FS` sources. | [File catalog](../../internal/filecatalog/catalog.go) |
|
||||||
| `internal/jsonvalue` | Validates and deeply copies bounded JSON-compatible extra-parameter and prepared-schema trees while preserving supported concrete value types and rejecting cycles or excessive depth and work. | [JSON values](../../internal/jsonvalue/jsonvalue.go) |
|
| `internal/jsonvalue` | Validates and deeply copies bounded JSON-compatible extra-parameter and prepared-schema trees while preserving supported concrete value types and rejecting cycles or excessive depth and work. | [JSON values](../../internal/jsonvalue/jsonvalue.go) |
|
||||||
@@ -30,9 +29,9 @@ contributor workflow and validation.
|
|||||||
| `internal/prompt` | Renders prompt messages from Go templates with artifact, variable, session, and cache-control data, and conservatively enumerates dependencies from captured template syntax. | [Go-template renderer](../../internal/prompt/go_renderer.go), [requirement discovery](../../internal/prompt/requirements.go) |
|
| `internal/prompt` | Renders prompt messages from Go templates with artifact, variable, session, and cache-control data, and conservatively enumerates dependencies from captured template syntax. | [Go-template renderer](../../internal/prompt/go_renderer.go), [requirement discovery](../../internal/prompt/requirements.go) |
|
||||||
| `internal/artifact` | Resolves ordinary inline and unrestricted caller-selected file references into copied artifacts with metadata and hashes. | [Internal sources and validation](sources.md) |
|
| `internal/artifact` | Resolves ordinary inline and unrestricted caller-selected file references into copied artifacts with metadata and hashes. | [Internal sources and validation](sources.md) |
|
||||||
| `internal/validate` | Validates basic, JSON, and JSON Schema output using operating-system filesystem or `fs.FS` schema sources and creates operation-local validation plans with canonical contained schema resources. | [Framework formats](../formats.md#schemas), [internal sources and validation](sources.md) |
|
| `internal/validate` | Validates basic, JSON, and JSON Schema output using operating-system filesystem or `fs.FS` schema sources and creates operation-local validation plans with canonical contained schema resources. | [Framework formats](../formats.md#schemas), [internal sources and validation](sources.md) |
|
||||||
| `internal/llm` | Defines the internal generation boundary and implements outbound OpenAI-compatible chat requests from resolved execution targets, including bounded structured non-success response decoding, successful-response decoding, authentication, deadline handling, and ownership of the OpenAI-compatible reserved request-field policy. | [Internal model client](llm.md) |
|
| `internal/llm` | Defines the internal generation boundary and implements outbound OpenAI-compatible chat requests from resolved execution targets, including bounded response decoding, authentication, deadline handling, per-invocation HTTP evidence and built-in diagnostic probes, and ownership of the OpenAI-compatible reserved request-field policy. | [Internal model client](llm.md) |
|
||||||
| `internal/observation` | Owns invocation-local run IDs, presence-aware usage and phase accounting, and synchronous metadata event delivery for ordinary and claimed prepared runs and generation attempts. | [Internal execution observation](observation.md) |
|
| `internal/observation` | Owns invocation-local run IDs, presence-aware usage and phase accounting, and synchronous metadata event delivery for ordinary and claimed prepared runs and generation attempts; smoke diagnostics keep their private evidence outside ordinary observer events. | [Internal execution observation](observation.md) |
|
||||||
| `internal/usecase` | Selects captured prompts and profiles, enumerates requirements from captured prompt syntax, applies request overrides and completion checks, and coordinates ordinary and single-claim prepared execution across rendering, artifact loading, operation-local validation plans, generation, capacity, and bounded repair. | [Internal runner](runner.md), [requirement inspection](../../internal/usecase/requirements_inspection.go), [prepared-execution implementation](../../internal/usecase/prepared_execution.go) |
|
| `internal/usecase` | Selects captured prompts and profiles, enumerates requirements from captured prompt syntax, applies request overrides and completion checks, coordinates ordinary and single-claim prepared execution across rendering, artifact loading, operation-local validation plans, generation, capacity, and bounded repair, and runs explicit smoke diagnostics with private cases, shared generation/capacity, and optional built-in HTTP probes. | [Internal runner](runner.md), [requirement inspection](../../internal/usecase/requirements_inspection.go), [prepared-execution implementation](../../internal/usecase/prepared_execution.go) |
|
||||||
|
|
||||||
The internal engine assembles these internal components without exposing their
|
The internal engine assembles these internal components without exposing their
|
||||||
representations. Consumers depend only on the root facade.
|
representations. Consumers depend only on the root facade.
|
||||||
|
|||||||
@@ -32,6 +32,12 @@ The runner has no durable run or session store.
|
|||||||
|
|
||||||
## Shared Prompt Selection
|
## Shared Prompt Selection
|
||||||
|
|
||||||
|
The internal engine applies each namespace view to slashless caller selections
|
||||||
|
before they reach the runner. The runner therefore selects captured prompts and
|
||||||
|
profiles by the resulting exact runtime IDs. Already-qualified selections pass
|
||||||
|
through, while configured defaults and stored references are used as authored
|
||||||
|
and are not requalified.
|
||||||
|
|
||||||
Ordinary preparation selects the full prompt definition and construction-time
|
Ordinary preparation selects the full prompt definition and construction-time
|
||||||
hash. It retains its early request-ID check before direct-session
|
hash. It retains its early request-ID check before direct-session
|
||||||
normalization. Referenced message content and static template syntax were
|
normalization. Referenced message content and static template syntax were
|
||||||
@@ -46,8 +52,8 @@ admission, or model collaborators. The root
|
|||||||
exact contract.
|
exact contract.
|
||||||
|
|
||||||
`InspectRequirements` uses the same metadata selection to resolve the
|
`InspectRequirements` uses the same metadata selection to resolve the
|
||||||
request-profile/default identity, then obtains the exact captured requirement
|
request-profile/default identity, then obtains the captured requirement
|
||||||
snapshot by the selected prompt ID and version. The analyzer receives only
|
snapshot by the selected prompt ID. The analyzer receives only
|
||||||
those identity fields rather than an execution definition. It analyzes the
|
those identity fields rather than an execution definition. It analyzes the
|
||||||
snapshot with the supplied caller variables and normalized direct-session
|
snapshot with the supplied caller variables and normalized direct-session
|
||||||
bypass; it does not resolve target readiness or enter the preparation
|
bypass; it does not resolve target readiness or enter the preparation
|
||||||
@@ -70,6 +76,37 @@ artifact, schema, rendering, admission, or model-client work. The root
|
|||||||
[`Engine.InspectProfile`](../../engine.go) GoDoc owns the public operation's
|
[`Engine.InspectProfile`](../../engine.go) GoDoc owns the public operation's
|
||||||
exact contract.
|
exact contract.
|
||||||
|
|
||||||
|
## Smoke-Test Diagnostics
|
||||||
|
|
||||||
|
The separate `SmokeTester` in `internal/usecase` selects from the same captured
|
||||||
|
configuration snapshot and backend/profile collaborators as the runner. The
|
||||||
|
internal engine applies namespace-view qualification to slashless caller IDs
|
||||||
|
before diagnostic selection; captured defaults and references remain exact.
|
||||||
|
Explicit profile selection takes precedence over prompt-default selection and a
|
||||||
|
backend diagnostic default; HTTP-only selection does not resolve a default
|
||||||
|
inference profile. Exact public selection rules belong to the root
|
||||||
|
[`Engine.SmokeTest` GoDoc](../../smoke_diagnostics.go).
|
||||||
|
|
||||||
|
Diagnostics do not call `Run`, `Prepare`, or the prompt preparation pipeline.
|
||||||
|
They do not render application messages, load application artifacts, use
|
||||||
|
application schemas, or inspect session templates. Private text and structured
|
||||||
|
cases and the structured case's schema remain internal to the diagnostic
|
||||||
|
operation; they are not entries in prompt/profile listings or inspection.
|
||||||
|
`InspectConfiguration` remains a separate, explicit operator-oriented view of
|
||||||
|
effective settings and source history. A diagnostic report may include selected
|
||||||
|
effective settings and identifiers, so consumers still apply their disclosure
|
||||||
|
policy.
|
||||||
|
|
||||||
|
The engine assembles the smoke tester with the runner's generation coordinator
|
||||||
|
and capacity manager. Inference holds the ordinary logical admission lease and
|
||||||
|
uses the same active permits, retries, timeout, and request evidence path as
|
||||||
|
generation. Reachability and authentication probes bypass generation capacity
|
||||||
|
and do not require a model. An engine with an injected `LLMClient` can run
|
||||||
|
inference diagnostics but has no built-in HTTP probe collaborator; HTTP-only
|
||||||
|
diagnostics report that limitation instead of falling back to another client.
|
||||||
|
The public GoDoc owns the caller-visible timeout, cancellation, report, and
|
||||||
|
transport semantics.
|
||||||
|
|
||||||
## Shared Preparation Pipeline
|
## Shared Preparation Pipeline
|
||||||
|
|
||||||
`Prepare` and `Run` share one private preparation pipeline split at the point
|
`Prepare` and `Run` share one private preparation pipeline split at the point
|
||||||
@@ -111,6 +148,12 @@ into its private payload, while deep-copying mutable provider extras and
|
|||||||
creating an independent details snapshot. Claim completion or discard clears
|
creating an independent details snapshot. Claim completion or discard clears
|
||||||
the execution payload without removing the details snapshot.
|
the execution payload without removing the details snapshot.
|
||||||
|
|
||||||
|
The root facade's `Engine.ValidateRequest` uses the same complete preparation
|
||||||
|
path as `Prepare` and discards the resulting internal prepared value without
|
||||||
|
converting it into a public snapshot. It does not add a runner operation or
|
||||||
|
validator component; request conversion and public error mapping remain at the
|
||||||
|
facade boundary.
|
||||||
|
|
||||||
Pointer-based numeric overrides preserve an explicit zero. Invalid negative or
|
Pointer-based numeric overrides preserve an explicit zero. Invalid negative or
|
||||||
out-of-range values fail as invalid requests. Endpoint overrides do not change
|
out-of-range values fail as invalid requests. Endpoint overrides do not change
|
||||||
the selected backend identity. Non-empty extra-parameter maps replace whole
|
the selected backend identity. Non-empty extra-parameter maps replace whole
|
||||||
@@ -250,4 +293,8 @@ Changes to orchestration should continue to use the existing package
|
|||||||
interfaces, keep request state local to an invocation, and preserve the shared
|
interfaces, keep request state local to an invocation, and preserve the shared
|
||||||
resolution and completion pipeline. Source, renderer, validator, or
|
resolution and completion pipeline. Source, renderer, validator, or
|
||||||
model-client contract changes belong first in their owning package and
|
model-client contract changes belong first in their owning package and
|
||||||
document.
|
document. The
|
||||||
|
[smoke selection tests](../../internal/usecase/smoke_selection_test.go),
|
||||||
|
[diagnostic orchestration tests](../../internal/usecase/smoke_tester_test.go),
|
||||||
|
and [private inference-case tests](../../internal/usecase/smoke_inference_test.go)
|
||||||
|
own diagnostic selection, report assembly, and inference findings.
|
||||||
|
|||||||
@@ -12,31 +12,65 @@ source semantics. Internal packages are not consumer APIs.
|
|||||||
|
|
||||||
`internal/configuration` is the single adapter from ConfigKit's final
|
`internal/configuration` is the single adapter from ConfigKit's final
|
||||||
effective configuration to execution-owned definitions. It performs one
|
effective configuration to execution-owned definitions. It performs one
|
||||||
layered load, captures effective presence (including explicit null), records
|
layered load, captures effective presence (including explicit null), builds
|
||||||
normalization and defaults through resolution, and validates all effective
|
detached normalized interpretations during validation, and validates all effective
|
||||||
backend, profile, and prompt values. Replaced lower-layer domain values are
|
root and collection backend, profile, and prompt values. Replaced lower-layer
|
||||||
not separately validated. It builds an immutable backend index and
|
domain values are not separately validated. It indexes root resources under
|
||||||
presence-aware profile targets, applying final backend defaults only after
|
their unqualified IDs and collection resources under their full
|
||||||
profile inheritance. It retains ConfigKit's result privately for explicit
|
`namespace/local-key` IDs while retaining ConfigKit's effective tree in its
|
||||||
inspection, not for per-run resolution. The runtime/domain packages do not
|
authored shape. It builds an immutable backend index and presence-aware profile
|
||||||
depend on ConfigKit.
|
targets, applying final backend defaults only after profile inheritance. Runtime
|
||||||
|
lookups use those final indexes and exact stored references; they do not rewrite
|
||||||
|
or resolve resources from ConfigKit source history. The runtime/domain packages
|
||||||
|
do not depend on ConfigKit.
|
||||||
|
|
||||||
After prompt materialization and effective-profile snapshot construction, the
|
ConfigKit owns source headers, imports, composition, and source evidence.
|
||||||
adapter captures lexically ordered, identity-only inventories from the final
|
Promptkit does not preparse contributions: it validates the final effective
|
||||||
prompt and indexed-profile maps. Its listing methods return caller-owned copies
|
values once, captures the indexed identities and their original resource
|
||||||
of those inventories without consulting ConfigKit or copying definitions.
|
contexts, and retains ConfigKit's composed result for explicit operator inspection.
|
||||||
|
Accepted non-main source headers are consumed during composition; the main
|
||||||
|
source declaration remains available in that inspection view. Collection
|
||||||
|
release labels are descriptive metadata, not selection inputs. The
|
||||||
|
[format reference](../formats.md#source-headers-collections-and-resource-ids)
|
||||||
|
owns the exact source-header and collection contracts.
|
||||||
|
|
||||||
|
The `ConfigurationInspection.Diff` facade method compares two retained results
|
||||||
|
through a private wrapper and a narrow `internal/configuration.Diff` bridge.
|
||||||
|
The wrapper keeps `Result[document]` inside the adapter; the bridge delegates
|
||||||
|
once to ConfigKit v1.0.0 and returns its public difference records. Comparison
|
||||||
|
uses only frozen effective values and does not reopen sources, resolve runtime
|
||||||
|
credentials, or enter the execution path. ConfigKit applies sensitivity from
|
||||||
|
both results; reports may still contain ordinary application data. See the
|
||||||
|
[consumer comparison guide](../consumers/pkg-promptkit.md#inspect-the-captured-configuration)
|
||||||
|
and ConfigKit's [v1.0.0 comparison contract](https://forge.maximumdirect.net/base-layer/configkit/src/tag/v1.0.0/docs/config.md#effective-configuration-diffs).
|
||||||
|
|
||||||
|
After resource materialization and effective-profile snapshot construction, the
|
||||||
|
adapter captures lexically ordered identity inventories for backends, profiles,
|
||||||
|
and prompts, per-kind resource namespace sets, and metadata for effective
|
||||||
|
collection declarations. Listing methods return caller-owned copies from those
|
||||||
|
captured values without consulting ConfigKit or copying resource definitions.
|
||||||
|
|
||||||
The root `DirectoryInputs` and `FilesystemInputs` helpers discover sorted YAML
|
The root `DirectoryInputs` and `FilesystemInputs` helpers discover sorted YAML
|
||||||
files under an explicit root, provide resource context, and leave imports
|
files under an explicit root, provide resource context, and leave imports
|
||||||
disabled. Each returned slice belongs to one strict-composition group; file
|
disabled. Each returned slice belongs to one strict-composition group; file
|
||||||
order does not confer priority. The engine prepends selected catalog and
|
order does not confer priority. Caller underlays are composed in their given
|
||||||
Promptkit-owned definitions, then caller underlays and optional main. The
|
order, followed by the optional main input. The
|
||||||
[configuration tests](../../internal/configuration/load_test.go) exercise the
|
[configuration tests](../../internal/configuration/load_test.go) exercise the
|
||||||
real loader and final-value handoff.
|
real loader and final-value handoff.
|
||||||
|
|
||||||
|
The public `CollectionInput` helper mounts one caller-selected source at
|
||||||
|
`collections/<namespace>` and enables ConfigKit imports for that input. The
|
||||||
|
helper does not read the source; ConfigKit retains responsibility for loading,
|
||||||
|
composition, imports, and source-local resource context. Imported or inherited
|
||||||
|
`content_file` values continue resolving relative to the source that contributed
|
||||||
|
the effective field, not to a flattened runtime identity. Explicit
|
||||||
|
`InspectConfiguration` views expose the retained effective configuration and
|
||||||
|
provenance for operator review; runtime selection and inventories do not derive
|
||||||
|
from source history.
|
||||||
|
|
||||||
## Prompt Definitions
|
## Prompt Definitions
|
||||||
|
|
||||||
The configuration adapter indexes each prompt by exact ID and version,
|
The configuration adapter indexes each prompt by exact ID,
|
||||||
materializes file-backed message content using the exact effective field's
|
materializes file-backed message content using the exact effective field's
|
||||||
origin and resource context, and checks static message/session template syntax
|
origin and resource context, and checks static message/session template syntax
|
||||||
at construction. It stores captured content, compiled templates, declared
|
at construction. It stores captured content, compiled templates, declared
|
||||||
@@ -48,14 +82,19 @@ declaration; absent and null fields remain distinguishable from explicit
|
|||||||
strings, including empty strings. It closes content-file handles before
|
strings, including empty strings. It closes content-file handles before
|
||||||
returning and retains no source capability for public inspection.
|
returning and retains no source capability for public inspection.
|
||||||
|
|
||||||
Role and cache-control normalization is applied to execution-owned message
|
Prompt materialization shares a lazy metadata snapshot across root and collection
|
||||||
copies. The retained ConfigKit configuration keeps effective input message
|
resources during construction, avoiding a full metadata copy per collection.
|
||||||
metadata and its resource origins: recording a sequence-wide normalization in
|
|
||||||
ConfigKit v0.6.0 would replace origins of unchanged content-file fields.
|
Normalization and defaults are applied to execution-owned interpretations,
|
||||||
|
including message roles and cache controls. ConfigKit retains the composed
|
||||||
|
values and origins, rather than synthetic Promptkit normalization events. List
|
||||||
|
indexes identify fields for presence, validation, sensitivity, and resource
|
||||||
|
context; full IDs select captured runtime indexes. Recording a sequence-wide
|
||||||
|
normalization would replace origins of unchanged content-file fields.
|
||||||
|
|
||||||
The runner selects full definitions from this index for preparation and uses
|
The runner selects full definitions from this index for preparation and uses
|
||||||
captured prompt metadata for `InspectPrompt` and `InspectRequirements`; the
|
captured prompt metadata for `InspectPrompt` and `InspectRequirements`; the
|
||||||
internal requirement snapshot lookup selects by exact prompt ID and version.
|
internal requirement snapshot lookup uses the selected prompt ID alone.
|
||||||
These paths do not rescan configuration or reopen message files. `InspectPrompt`
|
These paths do not rescan configuration or reopen message files. `InspectPrompt`
|
||||||
returns declared metadata without rendering or resolving profile, input, or
|
returns declared metadata without rendering or resolving profile, input, or
|
||||||
schema resources, and its public shape and prompt hashes do not include the
|
schema resources, and its public shape and prompt hashes do not include the
|
||||||
@@ -63,8 +102,8 @@ captured presence state. Runtime rendering still checks request variables and
|
|||||||
input helpers. The [prompt adapter tests](../../internal/configuration/prompts_test.go)
|
input helpers. The [prompt adapter tests](../../internal/configuration/prompts_test.go)
|
||||||
cover resource origins, context containment, capture, and selection.
|
cover resource origins, context containment, capture, and selection.
|
||||||
|
|
||||||
The configuration adapter shares exact ID/version selection across its
|
The configuration adapter shares ID-only selection across its internal prompt
|
||||||
internal prompt lookups. The execution snapshot lookup returns an owned prompt
|
lookups. The execution snapshot lookup returns an owned prompt
|
||||||
definition and cached hash; metadata inspection returns owned input metadata
|
definition and cached hash; metadata inspection returns owned input metadata
|
||||||
without copying execution templates. Profile selection likewise has an
|
without copying execution templates. Profile selection likewise has an
|
||||||
identity-only lookup for consumers that do not need the execution target,
|
identity-only lookup for consumers that do not need the execution target,
|
||||||
@@ -102,18 +141,12 @@ dependency-bearing range scopes make discovery incomplete. Uncalled definitions
|
|||||||
and bypassed session templates are not traversed. This internal walker does not
|
and bypassed session templates are not traversed. This internal walker does not
|
||||||
change rendering behavior.
|
change rendering behavior.
|
||||||
|
|
||||||
## Profiles And Built-Ins
|
## Profiles
|
||||||
|
|
||||||
`internal/catalog` selects the released keyed OpenRouter and Rakestrawhome
|
ConfigKit resolves profile inheritance before the handoff. Within a collection,
|
||||||
assets as one ConfigKit underlay and PromptKit-owned profiles as the next.
|
`extends: {id: parent}` names a sibling local ID; it is not a cross-collection reference.
|
||||||
It discovers YAML inputs and supplies passive filesystem context without
|
The configuration adapter validates final effective resource references and
|
||||||
parsing or pre-validating catalog definitions. The configuration loader
|
field values, then builds target
|
||||||
validates only the final effective backend and profile values, including
|
|
||||||
consumer overlays of maintained bases or backends. There is no catalog-only
|
|
||||||
preflight, reserved source namespace, or replay of backend registration.
|
|
||||||
|
|
||||||
ConfigKit resolves profile inheritance before the handoff. The configuration
|
|
||||||
adapter validates effective references and field values, then builds target
|
|
||||||
snapshots with backend defaults and presence/suppression state. A profile can
|
snapshots with backend defaults and presence/suppression state. A profile can
|
||||||
remain partial until runtime overrides complete it. `InspectProfile` selects
|
remain partial until runtime overrides complete it. `InspectProfile` selects
|
||||||
that captured target without prompt, artifact, schema, credential lookup, or
|
that captured target without prompt, artifact, schema, credential lookup, or
|
||||||
@@ -121,8 +154,7 @@ provider work. Preparation applies runtime overrides and then checks target
|
|||||||
completeness. Identity-only profile selection can identify a partial captured
|
completeness. Identity-only profile selection can identify a partial captured
|
||||||
profile without copying its target or requiring readiness. The
|
profile without copying its target or requiring readiness. The
|
||||||
[target tests](../../internal/configuration/targets_test.go) cover effective
|
[target tests](../../internal/configuration/targets_test.go) cover effective
|
||||||
target interpretation, while the [catalog tests](../../internal/catalog/catalog_test.go)
|
target interpretation.
|
||||||
cover selected released assets.
|
|
||||||
|
|
||||||
The internal engine delegates listing through a narrow identity-inventory
|
The internal engine delegates listing through a narrow identity-inventory
|
||||||
interface directly to the configuration snapshot. The execution runner has no
|
interface directly to the configuration snapshot. The execution runner has no
|
||||||
|
|||||||
@@ -26,47 +26,17 @@ License and notices: [CC BY-SA 4.0](licenses/CC-BY-SA-4.0.txt) |
|
|||||||
|
|
||||||
## ConfigKit
|
## ConfigKit
|
||||||
|
|
||||||
Selected module: `gitea.maximumdirect.net/eric/ConfigKit` at `v0.6.0`.
|
Selected module: `go.maximumdirect.net/configkit` at `v1.0.0`.
|
||||||
|
|
||||||
Copyright (C) 2026 Eric Rakestraw
|
Copyright (C) 2026 Eric Rakestraw
|
||||||
|
|
||||||
SPDX-License-Identifier: LGPL-3.0-or-later
|
SPDX-License-Identifier: LGPL-3.0-or-later
|
||||||
|
|
||||||
License and notices: [LGPL 3.0](../../LICENSE) |
|
License and notices: [LGPL 3.0](../../LICENSE) |
|
||||||
[COPYRIGHT](https://gitea.maximumdirect.net/eric/ConfigKit/src/commit/1a885934c28733d9a5dca261fd6da0e2a4279285/COPYRIGHT) |
|
[COPYRIGHT](https://forge.maximumdirect.net/base-layer/configkit/src/commit/c88aac990b23f48a31f9046b830d4d0954f57f53/COPYRIGHT) |
|
||||||
[LICENSE](https://gitea.maximumdirect.net/eric/ConfigKit/src/commit/1a885934c28733d9a5dca261fd6da0e2a4279285/LICENSE).
|
[LICENSE](https://forge.maximumdirect.net/base-layer/configkit/src/commit/c88aac990b23f48a31f9046b830d4d0954f57f53/LICENSE).
|
||||||
|
|
||||||
[Source](https://gitea.maximumdirect.net/eric/ConfigKit/src/commit/1a885934c28733d9a5dca261fd6da0e2a4279285).
|
[Source](https://forge.maximumdirect.net/base-layer/configkit/src/commit/c88aac990b23f48a31f9046b830d4d0954f57f53).
|
||||||
|
|
||||||
## Promptkit OpenRouter Catalog v3
|
|
||||||
|
|
||||||
Selected module: `gitea.maximumdirect.net/eric/promptkit-backend-openrouter/v3`
|
|
||||||
at `v3.20260930.0`.
|
|
||||||
|
|
||||||
Copyright (C) 2026 Eric Rakestraw
|
|
||||||
|
|
||||||
SPDX-License-Identifier: MIT
|
|
||||||
|
|
||||||
License and notices: [MIT](licenses/MIT.txt) |
|
|
||||||
[COPYRIGHT](https://gitea.maximumdirect.net/eric/promptkit-backend-openrouter/src/commit/f17d208cb7ad1fb043cda2266cd3011d11b40aa0/COPYRIGHT) |
|
|
||||||
[LICENSE](https://gitea.maximumdirect.net/eric/promptkit-backend-openrouter/src/commit/f17d208cb7ad1fb043cda2266cd3011d11b40aa0/LICENSE).
|
|
||||||
|
|
||||||
[Source](https://gitea.maximumdirect.net/eric/promptkit-backend-openrouter/src/commit/f17d208cb7ad1fb043cda2266cd3011d11b40aa0).
|
|
||||||
|
|
||||||
## Promptkit Rakestrawhome Catalog v3
|
|
||||||
|
|
||||||
Selected module: `gitea.maximumdirect.net/eric/promptkit-backend-rakestrawhome/v3`
|
|
||||||
at `v3.20260930.0`.
|
|
||||||
|
|
||||||
Copyright (C) 2026 Eric Rakestraw
|
|
||||||
|
|
||||||
SPDX-License-Identifier: MIT
|
|
||||||
|
|
||||||
License and notices: [MIT](licenses/MIT.txt) |
|
|
||||||
[COPYRIGHT](https://gitea.maximumdirect.net/eric/promptkit-backend-rakestrawhome/src/commit/993443d88c451901f4c917fa00c204fd3b54d28d/COPYRIGHT) |
|
|
||||||
[LICENSE](https://gitea.maximumdirect.net/eric/promptkit-backend-rakestrawhome/src/commit/993443d88c451901f4c917fa00c204fd3b54d28d/LICENSE).
|
|
||||||
|
|
||||||
[Source](https://gitea.maximumdirect.net/eric/promptkit-backend-rakestrawhome/src/commit/993443d88c451901f4c917fa00c204fd3b54d28d).
|
|
||||||
|
|
||||||
## jsonschema
|
## jsonschema
|
||||||
|
|
||||||
|
|||||||
@@ -51,8 +51,8 @@ The [internal component overview](../internal/overview.md) owns the inventory
|
|||||||
of implemented packages and their concrete responsibilities. This policy owns
|
of implemented packages and their concrete responsibilities. This policy owns
|
||||||
the boundaries and dependency rules those components must preserve.
|
the boundaries and dependency rules those components must preserve.
|
||||||
|
|
||||||
The internal engine composes selected catalog and caller ConfigKit inputs once,
|
The internal engine composes caller-selected ConfigKit inputs once, then
|
||||||
then assembles the captured definitions, capacity manager, renderer, validator,
|
assembles the captured definitions, capacity manager, renderer, validator,
|
||||||
outbound client, and use-case runner. The configuration adapter interprets and
|
outbound client, and use-case runner. The configuration adapter interprets and
|
||||||
validates only the final effective values, including presence, null, and
|
validates only the final effective values, including presence, null, and
|
||||||
resource context. It retains source history for explicit operator inspection,
|
resource context. It retains source history for explicit operator inspection,
|
||||||
@@ -97,7 +97,8 @@ on consumers or on Scriptorium.
|
|||||||
`internal/domain` owns source-neutral invariants for values shared across
|
`internal/domain` owns source-neutral invariants for values shared across
|
||||||
multiple input and execution boundaries, including execution-setting bounds,
|
multiple input and execution boundaries, including execution-setting bounds,
|
||||||
OpenAI-compatible base endpoints, session identifiers, and output-contract
|
OpenAI-compatible base endpoints, session identifiers, and output-contract
|
||||||
legality. Callers retain source parsing, required-field rules, other
|
legality, plus shared resource-identity syntax and qualification. Callers retain
|
||||||
|
source parsing, required-field rules, other
|
||||||
source-specific normalization, defaulting, error classification, and policy
|
source-specific normalization, defaulting, error classification, and policy
|
||||||
specific to their own boundary.
|
specific to their own boundary.
|
||||||
|
|
||||||
|
|||||||
@@ -88,7 +88,7 @@ secret values.
|
|||||||
| Release-note history | `docs/releases/` | One checked-in summary per source release under the procedure; the note at its immutable tag is the release record. | Current commands, behavior, contracts, and compatibility definitions. |
|
| Release-note history | `docs/releases/` | One checked-in summary per source release under the procedure; the note at its immutable tag is the release record. | Current commands, behavior, contracts, and compatibility definitions. |
|
||||||
| Complete copyable artifacts | `examples/` | Maintained configuration, inputs, and other copyable or runnable files. | Field-by-field reference, command reference, prose explanation. |
|
| Complete copyable artifacts | `examples/` | Maintained configuration, inputs, and other copyable or runnable files. | Field-by-field reference, command reference, prose explanation. |
|
||||||
| Exact exported Go API | Go declarations and GoDoc, as APIs are implemented | Exported names, signatures, types, values, errors, and exact behavioral contracts. | Task-oriented consumer walkthroughs, implementation details, and future API proposals. |
|
| Exact exported Go API | Go declarations and GoDoc, as APIs are implemented | Exported names, signatures, types, values, errors, and exact behavioral contracts. | Task-oriented consumer walkthroughs, implementation details, and future API proposals. |
|
||||||
| Framework file formats | `docs/formats.md` | Prompt-definition and profile YAML fields, schema references, defaults, validation modes, built-in profiles, credentials, and file-to-request precedence. | Exported Go declarations, outbound wire behavior, internal parsing mechanics, and application configuration. |
|
| Framework file formats | `docs/formats.md` | Prompt-definition and profile YAML fields, schema references, defaults, validation modes, credentials, and file-to-request precedence. | Exported Go declarations, outbound wire behavior, internal parsing mechanics, and application configuration. |
|
||||||
|
|
||||||
Create supporting documents for existing interfaces and responsibilities when
|
Create supporting documents for existing interfaces and responsibilities when
|
||||||
substantive content is available.
|
substantive content is available.
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
**Base Policy Version:** 1.8
|
**Base Policy Version:** 1.8
|
||||||
|
|
||||||
**Last Updated**: 2026-09-27
|
**Last Updated**: 2026-11-02
|
||||||
|
|
||||||
**Upstream Source:** [oss.md](https://gitea.maximumdirect.net/eric/policy/src/commit/d84a38ebab26f048cafbe59a2246700c35d29843/docs/policy/oss.md)
|
**Upstream Source:** [oss.md](https://gitea.maximumdirect.net/eric/policy/src/commit/d84a38ebab26f048cafbe59a2246700c35d29843/docs/policy/oss.md)
|
||||||
|
|
||||||
@@ -221,7 +221,8 @@ Promptkit retains its LGPL-3.0-or-later library grant in
|
|||||||
[COPYRIGHT](../../COPYRIGHT). Adapted policy documentation has the separate
|
[COPYRIGHT](../../COPYRIGHT). Adapted policy documentation has the separate
|
||||||
scope identified there and in [attribution](../oss/attribution.md).
|
scope identified there and in [attribution](../oss/attribution.md).
|
||||||
|
|
||||||
Promptkit publishes source-only Go module tags on Gitea, with no binaries or
|
Promptkit publishes source-only Go module tags and Gitea release pages, with no
|
||||||
separate hosted download page. The [release procedure](../release.md) owns
|
binaries. Each new hosted page reuses the complete checked-in release note,
|
||||||
publication and concrete footer URLs. The hosted-page guidance applies if such
|
including its licensing footer. The [release procedure](../release.md) owns
|
||||||
a channel is deliberately introduced; it does not require creating one.
|
source publication, hosted delivery, and concrete footer URLs. Previously
|
||||||
|
published notes and tags retain their original records.
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
**Base Policy Version:** 1.6
|
**Base Policy Version:** 1.6
|
||||||
|
|
||||||
**Last Updated**: 2026-10-08
|
**Last Updated**: 2026-11-02
|
||||||
|
|
||||||
**Upstream Source:** [release.md](https://gitea.maximumdirect.net/eric/policy/src/commit/e833faddf120c789a9b45348edaf75720de16348/docs/policy/release.md)
|
**Upstream Source:** [release.md](https://gitea.maximumdirect.net/eric/policy/src/commit/e833faddf120c789a9b45348edaf75720de16348/docs/policy/release.md)
|
||||||
|
|
||||||
@@ -241,9 +241,13 @@ navigation on 2026-09-26. Apply them prospectively; previously published notes
|
|||||||
and tags retain their original records.
|
and tags retain their original records.
|
||||||
|
|
||||||
Promptkit publishes source-only Go modules from main to origin on Gitea, using
|
Promptkit publishes source-only Go modules from main to origin on Gitea, using
|
||||||
annotated stable SemVer tags. It has no binaries, hosted download pages, or
|
annotated stable SemVer tags. The source commit is pushed through main before
|
||||||
asynchronous deliverables. The source commit is pushed through main before the
|
the tag. After source publication, maintainers use ReleaseKit locally to deliver
|
||||||
tag. The [release procedure](../release.md) owns commands and recovery.
|
a Gitea release page containing the complete checked-in note, including its
|
||||||
|
licensing footer. There are no binaries or other deliverables. Source publication
|
||||||
|
and hosted delivery have separate outcomes; delivery credentials and service
|
||||||
|
availability do not gate source-release completion. The
|
||||||
|
[release procedure](../release.md) owns commands and recovery.
|
||||||
|
|
||||||
Release preparation uses the latest Go installation available in the development
|
Release preparation uses the latest Go installation available in the development
|
||||||
environment to build the maintainer release executable and validate the
|
environment to build the maintainer release executable and validate the
|
||||||
@@ -267,9 +271,11 @@ The [publication command](../../scripts/release.sh) delegates to the released
|
|||||||
ReleaseKit tool selected in `go.mod`. The committed
|
ReleaseKit tool selected in `go.mod`. The committed
|
||||||
[profile](../../releasekit.json) selects the race-enabled Go suite, full vet,
|
[profile](../../releasekit.json) selects the race-enabled Go suite, full vet,
|
||||||
committed Go formatting, local Markdown links, workspace and filesystem
|
committed Go formatting, local Markdown links, workspace and filesystem
|
||||||
replacement inspection, and the offline semantic checks for the three
|
replacement inspection. The Go suite includes the offline semantic checks for
|
||||||
maintained consumer examples. These are the selected checks for the final
|
the three maintained consumer examples. It also rejects the configured local
|
||||||
candidate; a separate ordinary test run or standalone build is not an
|
delivery token path if committed; this narrowly scoped check is not a general credential
|
||||||
|
scan. These are the selected checks for the final candidate; a separate
|
||||||
|
ordinary test run or standalone build is not an
|
||||||
additional release gate. The upstream tool owns candidate, remote, and tag
|
additional release gate. The upstream tool owns candidate, remote, and tag
|
||||||
publication checks. It returns native status 0 for confirmed publication, 1
|
publication checks. It returns native status 0 for confirmed publication, 1
|
||||||
for a known validation or publication failure, 2 for invalid input or profile,
|
for a known validation or publication failure, 2 for invalid input or profile,
|
||||||
@@ -279,28 +285,8 @@ captured publication endpoint before retrying; the repository-specific
|
|||||||
instructions. Do not wait for CI or Go module availability. Licensing footer
|
instructions. Do not wait for CI or Go module availability. Licensing footer
|
||||||
URLs are preparation work, not a network gate.
|
URLs are preparation work, not a network gate.
|
||||||
|
|
||||||
## Catalog Profile Compatibility
|
Hosted delivery is a separate post-publication step for new releases. It reuses
|
||||||
|
the immutable tag and note without rerunning candidate validation or waiting
|
||||||
External catalog profile data may be added, removed, renamed, or modified
|
for CI. Retry failed delivery against that same version after resolving any
|
||||||
without deprecation or advance notice. This exception is limited to profile
|
uncertain hosted write; preserve published tags and hosted content. Report
|
||||||
data imported from the maintained catalog modules. It does not weaken ordinary
|
delivery status separately from the completed source release.
|
||||||
compatibility for Promptkit's public Go API, configuration and format semantics,
|
|
||||||
runtime behavior, catalog-module APIs, manifest schema, backend definitions, or
|
|
||||||
consumer-owned definitions.
|
|
||||||
|
|
||||||
Within the catalog versions selected and tested by a Promptkit release, and
|
|
||||||
unless a consumer overrides the name or its base, Promptkit keeps the literal
|
|
||||||
profile IDs `promptkit-openrouter-standard` and
|
|
||||||
`promptkit-openrouter-auto` available. The names do not promise a permanent
|
|
||||||
model, backend, routing behavior, settings, cost, output, or upstream
|
|
||||||
availability. The [framework format reference](../formats.md#built-in-profile-catalog)
|
|
||||||
owns their current definitions.
|
|
||||||
|
|
||||||
`v0.10.0` is the initial minor release for this compatibility transition.
|
|
||||||
Afterward, catalog-only updates and adjustments to the current selections may
|
|
||||||
ship in a patch release when all other compatibility obligations remain intact.
|
|
||||||
External profile removals can require consumer action; they are not automatic
|
|
||||||
migrations.
|
|
||||||
|
|
||||||
Catalog adoption and release validation remain local and offline. They do not
|
|
||||||
probe provider endpoints, request model lists, or make inference calls.
|
|
||||||
|
|||||||
@@ -60,10 +60,10 @@ documented validation model.
|
|||||||
|
|
||||||
The selected ReleaseKit profile runs the race-enabled package suite and full
|
The selected ReleaseKit profile runs the race-enabled package suite and full
|
||||||
vet, checks committed Go formatting, local Markdown links, and module
|
vet, checks committed Go formatting, local Markdown links, and module
|
||||||
distribution hygiene, and executes semantic assertions for the three
|
distribution hygiene. The Go suite includes semantic assertions for the three
|
||||||
maintained offline consumer examples. ReleaseKit owns this shared validation
|
maintained offline consumer examples. ReleaseKit owns this shared validation
|
||||||
machinery and publication workflow. The test run builds the packages; the
|
machinery and publication workflow. The test run builds the packages and
|
||||||
examples also exercise ordinary compilation. Separate ordinary tests and a
|
exercises the examples. Separate ordinary tests and a
|
||||||
standalone build are not additional release gates. Ordinary tests remain useful
|
standalone build are not additional release gates. Ordinary tests remain useful
|
||||||
during development. The preparation example protects assembled preparation and
|
during development. The preparation example protects assembled preparation and
|
||||||
inspection behavior. The execution example separately protects assembled
|
inspection behavior. The execution example separately protects assembled
|
||||||
|
|||||||
181
docs/release.md
181
docs/release.md
@@ -1,26 +1,26 @@
|
|||||||
# Release Procedure
|
# Release Procedure
|
||||||
|
|
||||||
This runbook implements the [release policy](policy/release.md). Promptkit
|
This runbook implements the [release policy](policy/release.md). Promptkit
|
||||||
publishes source-only Go module tags from `main` to `origin`. A successful push
|
publishes source-only Go module tags from `main` to `origin`, followed by a
|
||||||
of the selected annotated tag, after its source commit is available on `main`,
|
page-only Gitea release. Successful publication of the intended tag, with its
|
||||||
completes the release. Do not wait for CI or Go module availability.
|
source commit available on `main`, completes the source release. Report hosted
|
||||||
|
delivery separately. Do not wait for CI or Go module availability.
|
||||||
|
|
||||||
## Prepare The Candidate
|
## Prepare The Candidate
|
||||||
|
|
||||||
Required tools are Git, Go with race-detector support, POSIX shell, and Python
|
Required tools are Git, Go with race-detector support, and POSIX shell. Work
|
||||||
3. Work from the repository root with push access to `origin`.
|
from the repository root with push access to `origin`.
|
||||||
|
|
||||||
Use the latest Go installation available locally for the release tool, the
|
Use the latest Go installation available locally for the release tool and its
|
||||||
candidate validation, and the maintained examples. Make it the active `go`
|
child commands. Put it first on `PATH` and keep it selected throughout:
|
||||||
command and record its version:
|
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
export GOTOOLCHAIN=local
|
export GOTOOLCHAIN=local
|
||||||
go version
|
go version
|
||||||
```
|
```
|
||||||
|
|
||||||
For a minor release, advance Promptkit's consumer minimum to the initial stable
|
For a minor release, normally advance the consumer minimum to the initial
|
||||||
release of that Go series before committing the candidate:
|
stable patch of that Go series:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
release_go_version=$(go env GOVERSION)
|
release_go_version=$(go env GOVERSION)
|
||||||
@@ -29,110 +29,119 @@ release_go_series=${release_go_series%.*}
|
|||||||
go mod edit "-go=${release_go_series}.0"
|
go mod edit "-go=${release_go_series}.0"
|
||||||
```
|
```
|
||||||
|
|
||||||
For example, Go 1.26.8 normally results in `go 1.26.0`. Keep a higher patch
|
Retain a higher patch minimum when required by a dependency or identified fix.
|
||||||
minimum if a dependency or identified correctness fix requires it. For a patch
|
For a patch release, preserve the existing minimum. Explain minimum increases
|
||||||
release, leave the consumer minimum unchanged; using a newer validation
|
under the [versioning policy](policy/release.md#versioning-and-compatibility).
|
||||||
toolchain does not itself raise that minimum. If the candidate needs a higher
|
Prepare dependency caches before committing the candidate:
|
||||||
minimum, prepare a minor release instead. See the
|
|
||||||
[consumer-minimum policy](policy/release.md#consumer-minimum-and-release-toolchain).
|
|
||||||
|
|
||||||
Prepare module caches before validation; this may update `go.sum` and belongs
|
|
||||||
before the candidate commit:
|
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
GOTOOLCHAIN=local go mod download
|
go mod download
|
||||||
```
|
```
|
||||||
|
|
||||||
Choose an unused stable version and create `docs/releases/<version>.md` with a
|
Choose an unused stable version and create `docs/releases/<version>.md` with a
|
||||||
title containing `Promptkit` and that exact version, a short summary, and any
|
title containing `Promptkit` and that exact version, a short summary, and any
|
||||||
relevant compatibility impact or upgrade instructions. No fixed section
|
compatibility impact or upgrade instructions. End the note with:
|
||||||
headings are required. Describe a raised Go minimum and its compatibility
|
|
||||||
impact under the [versioning policy](policy/release.md#versioning-and-compatibility).
|
|
||||||
End each new note with the licensing footer below, using the selected version:
|
|
||||||
|
|
||||||
```markdown
|
```markdown
|
||||||
[COPYRIGHT](https://gitea.maximumdirect.net/eric/promptkit/src/tag/vX.Y.Z/COPYRIGHT) | [LICENSE](https://gitea.maximumdirect.net/eric/promptkit/src/tag/vX.Y.Z/LICENSE) | [ATTRIBUTION](https://gitea.maximumdirect.net/eric/promptkit/src/tag/vX.Y.Z/docs/oss/attribution.md)
|
[COPYRIGHT](https://forge.maximumdirect.net/base-layer/promptkit/src/tag/vX.Y.Z/COPYRIGHT) | [LICENSE](https://forge.maximumdirect.net/base-layer/promptkit/src/tag/vX.Y.Z/LICENSE) | [ATTRIBUTION](https://forge.maximumdirect.net/base-layer/promptkit/src/tag/vX.Y.Z/docs/oss/attribution.md)
|
||||||
```
|
```
|
||||||
|
|
||||||
Check the footer paths against the candidate; the future tag need not resolve
|
Substitute the selected version and check the paths against the candidate;
|
||||||
remotely during preparation. Follow the [OSS policy](policy/oss.md) for these
|
future tag URLs need not resolve during preparation. Follow the
|
||||||
links. Promptkit publishes no binaries, hosted download page, or other
|
[OSS policy](policy/oss.md). Historical notes and tags remain unchanged.
|
||||||
asynchronous deliverables.
|
|
||||||
|
|
||||||
Retire completed roadmaps while preserving deferred work and repairing incoming
|
Supply delivery credentials through `RELEASEKIT_GITEA_TOKEN` or the ignored
|
||||||
links. Review the intended changes through the ordinary development workflow,
|
local file `.releasekit/gitea-token`, with owner-only file permissions. A
|
||||||
commit the candidate on `main`, and push `main` to `origin` before publication.
|
nonblank environment value takes precedence. Source publication neither reads
|
||||||
Preparation may update module metadata; the release bootstrap and validation
|
nor requires this token. The [profile](../releasekit.json) selects the token
|
||||||
preserve the committed candidate.
|
path for committed-file protection; keep credentials out of commits and logs.
|
||||||
|
|
||||||
|
Retire completed roadmaps, preserve unfinished work, and repair affected links.
|
||||||
|
Review and commit the candidate on `main`, including any module updates, then
|
||||||
|
push `main` to `origin` before publishing its tag.
|
||||||
|
|
||||||
## Validate And Publish
|
## Validate And Publish
|
||||||
|
|
||||||
For an optional local diagnostic of a committed candidate, run:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
./scripts/releasekit.sh check vMAJOR.MINOR.PATCH
|
|
||||||
```
|
|
||||||
|
|
||||||
This is not a required step before publication. The upstream
|
|
||||||
[candidate-check contract](https://gitea.maximumdirect.net/eric/ReleaseKit/src/tag/v0.3.0/docs/consumers/check.md)
|
|
||||||
describes its requirements.
|
|
||||||
|
|
||||||
Run the single publication command with the chosen version:
|
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
./scripts/release.sh vMAJOR.MINOR.PATCH
|
./scripts/release.sh vMAJOR.MINOR.PATCH
|
||||||
```
|
```
|
||||||
|
|
||||||
The familiar wrapper delegates to the native ReleaseKit executable selected in
|
The launcher uses `go tool` to build or reuse the module-selected ReleaseKit
|
||||||
`go.mod`. The committed [profile](../releasekit.json) selects the race-enabled
|
executable in Go's cache, using the selected local toolchain. ReleaseKit runs
|
||||||
Go suite, full vet, committed Go formatting, local Markdown links, workspace
|
the [profile's checks](../releasekit.json) once, verifies publication state, and
|
||||||
and filesystem replacement inspection, and semantic checks for the three
|
publishes only the intended tag. Preserve its native exit status and diagnostic.
|
||||||
maintained offline consumer examples. ReleaseKit also verifies the committed
|
Successful publication needs no separate remote read-back or CI wait.
|
||||||
candidate and publication state, then publishes only the selected tag. Its
|
|
||||||
checks run once for this candidate; do not repeat them as a separate sign-off.
|
|
||||||
|
|
||||||
The native command returns status 0 for confirmed publication, 1 for a known
|
For optional local diagnosis, use `./scripts/releasekit.sh check VERSION`.
|
||||||
validation or publication failure, 2 for invalid input or profile, and 3 when
|
It is not a required step before publication. The upstream
|
||||||
the push outcome remains unknown. Successful publication needs no remote
|
[candidate-check guide](https://forge.maximumdirect.net/base-layer/releasekit/src/tag/v0.8.0/docs/consumers/check.md)
|
||||||
read-back, CI wait, or installation check. Provider probes and inference calls
|
and [CLI contract](https://forge.maximumdirect.net/base-layer/releasekit/src/tag/v0.8.0/docs/cli.md)
|
||||||
are not part of validation.
|
own shared checks and exit-status definitions.
|
||||||
|
|
||||||
## Catalog Profile Compatibility
|
## Deliver The Hosted Release
|
||||||
|
|
||||||
The [release policy](policy/release.md#catalog-profile-compatibility) owns the
|
After source publication, keep a clean checkout at the published tag's commit:
|
||||||
catalog compatibility boundary. This heading preserves older incoming links.
|
|
||||||
|
```sh
|
||||||
|
./scripts/releasekit.sh deliver vMAJOR.MINOR.PATCH
|
||||||
|
```
|
||||||
|
|
||||||
|
The profile selects page-only Gitea delivery for this repository. The hosted
|
||||||
|
body is the complete checked-in note, including its licensing footer. There are
|
||||||
|
no binary assets, checksum manifests, candidate revalidation, or CI waits.
|
||||||
|
ReleaseKit checks delivery credentials during delivery, not as a publication
|
||||||
|
gate. Report the hosted URL on success; delivery failure leaves the source
|
||||||
|
release complete.
|
||||||
|
|
||||||
|
For a later retry, use a clean checkout of the original tag with its recorded
|
||||||
|
module files and supply the token there. In a separate checkout, for example:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
git switch --detach vMAJOR.MINOR.PATCH
|
||||||
|
./scripts/releasekit.sh deliver vMAJOR.MINOR.PATCH
|
||||||
|
```
|
||||||
|
|
||||||
|
Resolve uncertain hosted writes before retrying the same immutable version.
|
||||||
|
Matching content is accepted; conflicts are not overwritten. Do not rerun
|
||||||
|
`publish` or move tags to repair delivery. Follow the upstream
|
||||||
|
[delivery guide](https://forge.maximumdirect.net/base-layer/releasekit/src/tag/v0.8.0/docs/consumers/delivery.md)
|
||||||
|
for result interpretation and recovery. These commands apply to tags containing
|
||||||
|
this delivery configuration; older releases retain their original workflows.
|
||||||
|
|
||||||
## Failure Recovery
|
## Failure Recovery
|
||||||
|
|
||||||
For status 1, use the diagnostic to distinguish a validation failure from a
|
For source-publication failures, use ReleaseKit's status and diagnostic to
|
||||||
known publication conflict. Correct and commit candidate defects, push `main`,
|
distinguish a candidate defect from a publication conflict. Correct and commit
|
||||||
and rerun publication with an unused version when appropriate. Status 2 means
|
candidate defects, push `main`, and rerun publication as appropriate. A failure
|
||||||
the invocation or profile must be corrected.
|
after local tag creation may leave a ref even when its object ID is unavailable.
|
||||||
|
|
||||||
For status 3, do not retry or remove the local tag until the remote outcome is
|
Status 3 means the push outcome remains unknown. Do not retry or remove the local
|
||||||
resolved. ReleaseKit reports the attempted version, tag object, and recovery
|
tag until the authoritative outcome is resolved. ReleaseKit attempts to save
|
||||||
state, including the captured publication endpoint when available. Use that
|
private publication evidence and reports a record path or a separate recording
|
||||||
endpoint—not merely the current `origin` URL—to query the exact tag; follow the
|
warning. A recording failure does not change the publication outcome.
|
||||||
upstream
|
|
||||||
[failure-recovery procedure](https://gitea.maximumdirect.net/eric/ReleaseKit/src/tag/v0.3.0/docs/release.md#resolve-failures):
|
Use the recovery command reported for that attempt, or discover local records
|
||||||
|
and explicitly select the matching attempt:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
releasekit_endpoint='COPY_CAPTURED_ENDPOINT'
|
./scripts/releasekit.sh publication-attempts
|
||||||
releasekit_version='vX.Y.Z'
|
./scripts/releasekit.sh reconcile --record /absolute/path/to/selected-record.json
|
||||||
test "$(git ls-remote --get-url -- "$releasekit_endpoint")" = "$releasekit_endpoint" &&
|
|
||||||
git ls-remote --refs -- "$releasekit_endpoint" "refs/tags/$releasekit_version"
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Compare the returned object ID with the reported tag object. An exact match
|
Discovery is local; reconciliation observes the original destination without
|
||||||
confirms publication. A missing ref confirms absence only when the endpoint
|
rerunning validation, changing tags, or delivering hosted content. Neither is
|
||||||
identity check and query both succeed. If either check fails, the outcome
|
a routine gate after successful publication. Follow the upstream
|
||||||
remains unknown; correct the transport configuration and resolve it before
|
[recovery procedure](https://forge.maximumdirect.net/base-layer/releasekit/src/tag/v0.8.0/docs/release.md#resolve-publication-failures)
|
||||||
retrying. Only after authoritative absence is confirmed may an unpublished
|
for outcomes, incomplete evidence, and older attempts without records.
|
||||||
local tag be removed before correcting the candidate or retrying. Never move,
|
|
||||||
overwrite, or delete a published tag.
|
|
||||||
|
|
||||||
## Policy Changes
|
Records are stored under Git's common directory by default and can contain
|
||||||
|
credential-bearing endpoints. Keep them private, out of source control and
|
||||||
|
shared logs; retain them while needed for recovery and remove them when that
|
||||||
|
value expires. See the [evidence guide](https://forge.maximumdirect.net/base-layer/releasekit/src/tag/v0.8.0/docs/consumers/publish.md#retain-and-reconcile-publication-evidence)
|
||||||
|
for storage and retention details.
|
||||||
|
|
||||||
Update the policy and this procedure together when changing release governance.
|
Current absence does not prove a version was never published. Remove a retained
|
||||||
Consumers own their dependency-availability and release checks; their readiness
|
local tag only after establishing absence and confirming it was not already
|
||||||
does not delay completion of a Promptkit release.
|
published or used by another release channel. Never reuse a known published
|
||||||
|
version or replace a published tag or hosted page. Corrections require a new
|
||||||
|
appropriate version.
|
||||||
|
|||||||
@@ -15,7 +15,7 @@ the existing Go API. This refactor requires no consumer code changes.
|
|||||||
|
|
||||||
This release selects OpenRouter `v2.20260922.1` and Rakestrawhome
|
This release selects OpenRouter `v2.20260922.1` and Rakestrawhome
|
||||||
`v2.20260922.0`; their exact inventories are linked from the
|
`v2.20260922.0`; their exact inventories are linked from the
|
||||||
[format reference](../formats.md#external-profile-inventories).
|
[migration identity mapping](../consumers/configuration-migration.md#identity-mapping).
|
||||||
|
|
||||||
The maintained names provide continuity only within the catalog versions
|
The maintained names provide continuity only within the catalog versions
|
||||||
selected and tested by a Promptkit release and when consumers do not override
|
selected and tested by a Promptkit release and when consumers do not override
|
||||||
@@ -37,8 +37,8 @@ an available profile or supply their own complete definition; the new
|
|||||||
`deepseek-flash-latest` and `deepseek-pro-latest` profiles are not automatic
|
`deepseek-flash-latest` and `deepseek-pro-latest` profiles are not automatic
|
||||||
aliases and need not preserve the previous settings.
|
aliases and need not preserve the previous settings.
|
||||||
|
|
||||||
See the [release policy](../release.md#catalog-profile-compatibility) for the
|
See the [release policy](../policy/release.md#versioning-and-compatibility) for the
|
||||||
compatibility boundary, the [format reference](../formats.md#built-in-profile-catalog)
|
compatibility boundary, the [migration identity mapping](../consumers/configuration-migration.md#identity-mapping)
|
||||||
for current Promptkit-owned definitions and selected external inventories, and
|
for current resource mappings, and
|
||||||
the [consumer guide](../consumers/pkg-promptkit.md#choose-a-profile-ownership-model)
|
the [consumer guide](../consumers/pkg-promptkit.md#choose-a-profile-ownership-model)
|
||||||
for configuration choices.
|
for configuration choices.
|
||||||
|
|||||||
@@ -72,5 +72,5 @@ for a structured proposal-and-assessment workflow.
|
|||||||
|
|
||||||
Backend catalog selections are unchanged from v0.10.0: OpenRouter
|
Backend catalog selections are unchanged from v0.10.0: OpenRouter
|
||||||
`v2.20260922.1` and Rakestrawhome `v2.20260922.0`. See the
|
`v2.20260922.1` and Rakestrawhome `v2.20260922.0`. See the
|
||||||
[catalog compatibility policy](../policy/release.md#catalog-profile-compatibility)
|
[release compatibility policy](../policy/release.md#versioning-and-compatibility)
|
||||||
and [profile inventories](../formats.md#external-profile-inventories).
|
and [migration identity mapping](../consumers/configuration-migration.md#identity-mapping).
|
||||||
|
|||||||
@@ -15,7 +15,7 @@ No public API, runtime behavior, or profile changes are introduced.
|
|||||||
Promptkit remains LGPL-3.0-or-later; the catalogs are now MIT-licensed.
|
Promptkit remains LGPL-3.0-or-later; the catalogs are now MIT-licensed.
|
||||||
See the [project grant](../../COPYRIGHT),
|
See the [project grant](../../COPYRIGHT),
|
||||||
[component attribution](../oss/attribution.md), and
|
[component attribution](../oss/attribution.md), and
|
||||||
[catalog compatibility policy](../policy/release.md#catalog-profile-compatibility).
|
[release compatibility policy](../policy/release.md#versioning-and-compatibility).
|
||||||
|
|
||||||
## Upgrade
|
## Upgrade
|
||||||
|
|
||||||
|
|||||||
@@ -35,7 +35,7 @@ for API and source-selection changes.
|
|||||||
Maintained OpenRouter and Rakestrawhome catalogs are selected as `/v3` modules,
|
Maintained OpenRouter and Rakestrawhome catalogs are selected as `/v3` modules,
|
||||||
both at `v3.20260930.0`. Their asset format changed; consumers that read catalog
|
both at `v3.20260930.0`. Their asset format changed; consumers that read catalog
|
||||||
assets directly must adopt the keyed format. The maintained Promptkit profile
|
assets directly must adopt the keyed format. The maintained Promptkit profile
|
||||||
IDs remain available under the [catalog compatibility policy](../policy/release.md#catalog-profile-compatibility),
|
IDs remain available under the [release compatibility policy](../policy/release.md#versioning-and-compatibility),
|
||||||
which does not promise fixed profile data.
|
which does not promise fixed profile data.
|
||||||
|
|
||||||
## Upgrade
|
## Upgrade
|
||||||
|
|||||||
@@ -19,7 +19,7 @@ increases to 1.26.0.
|
|||||||
engine's captured configuration, are lexically ordered and caller-owned, and
|
engine's captured configuration, are lexically ordered and caller-owned, and
|
||||||
include consumer definitions and maintained profiles that remain effective.
|
include consumer definitions and maintained profiles that remain effective.
|
||||||
Listing performs no provider or execution work. See the
|
Listing performs no provider or execution work. See the
|
||||||
[discovery guide](../consumers/pkg-promptkit.md#discover-available-profiles-and-prompts)
|
[discovery guide](../consumers/pkg-promptkit.md#discover-available-resources-and-collections)
|
||||||
and [GoDoc](../../listing.go).
|
and [GoDoc](../../listing.go).
|
||||||
|
|
||||||
## Efficiency And Tooling
|
## Efficiency And Tooling
|
||||||
|
|||||||
48
docs/releases/v0.14.0.md
Normal file
48
docs/releases/v0.14.0.md
Normal file
@@ -0,0 +1,48 @@
|
|||||||
|
# Promptkit v0.14.0
|
||||||
|
|
||||||
|
This release adds comparison of captured configuration inspections and updates
|
||||||
|
ConfigKit and the maintainer release tool. The minimum supported Go version
|
||||||
|
remains 1.26.0.
|
||||||
|
|
||||||
|
## Compare Captured Configurations
|
||||||
|
|
||||||
|
`ConfigurationInspection.Diff` compares the effective configuration captured by
|
||||||
|
two engines. Consumers can use it to review a candidate configuration, inspect
|
||||||
|
an overlay's effect, or present configuration changes to operators.
|
||||||
|
|
||||||
|
Comparison delegates to ConfigKit and returns its difference records, including
|
||||||
|
presence information, paired redaction, and protected-change indicators. It
|
||||||
|
does not reload sources or contact providers. Source-history differences alone
|
||||||
|
do not produce value differences.
|
||||||
|
|
||||||
|
An empty diff is not proof of equivalent execution: referenced file contents,
|
||||||
|
resolved credentials, later execution preparation, and request-specific
|
||||||
|
overrides are outside the comparison. Records can contain ordinary application
|
||||||
|
data; callers retain responsibility for their disclosure.
|
||||||
|
|
||||||
|
See the [configuration comparison guide](../consumers/pkg-promptkit.md#inspect-the-captured-configuration)
|
||||||
|
and [GoDoc](../../configuration_inspection.go) for usage and the exact contract.
|
||||||
|
|
||||||
|
## Dependency And Tooling Updates
|
||||||
|
|
||||||
|
- Upgrade ConfigKit from v0.6.0 to v0.7.1, providing the upstream comparison API.
|
||||||
|
v0.7.1 also updates ConfigKit's maintainer tooling without changing its runtime
|
||||||
|
behavior from v0.7.0.
|
||||||
|
- Upgrade the module-selected ReleaseKit tool from v0.3.0 to v0.4.1. Promptkit
|
||||||
|
retains its existing root-module profile, publication entry point, and release
|
||||||
|
gates. See the [release procedure](../release.md) for maintainer commands.
|
||||||
|
|
||||||
|
## Compatibility And Upgrade
|
||||||
|
|
||||||
|
No application-code, configuration, or Go-toolchain migration is required from
|
||||||
|
v0.13.0. Configuration comparison is an optional API addition; existing
|
||||||
|
construction, inspection, preparation, and execution workflows remain available.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
go get gitea.maximumdirect.net/eric/promptkit@v0.14.0
|
||||||
|
```
|
||||||
|
|
||||||
|
See [Go compatibility](../consumers/pkg-promptkit.md#go-compatibility) for the
|
||||||
|
distinction between the consumer minimum and maintainer toolchain.
|
||||||
|
|
||||||
|
[COPYRIGHT](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.14.0/COPYRIGHT) | [LICENSE](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.14.0/LICENSE) | [ATTRIBUTION](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.14.0/docs/oss/attribution.md)
|
||||||
34
docs/releases/v0.15.0.md
Normal file
34
docs/releases/v0.15.0.md
Normal file
@@ -0,0 +1,34 @@
|
|||||||
|
# Promptkit v0.15.0
|
||||||
|
|
||||||
|
This release adds error-only validation of a concrete prompt request without
|
||||||
|
calling a model. The minimum supported Go version remains 1.26.0.
|
||||||
|
|
||||||
|
## Validate A Concrete Request
|
||||||
|
|
||||||
|
`Engine.ValidateRequest` accepts an ordinary `RunRequest` and returns nil when
|
||||||
|
it passes preparation, or the existing preparation error. Consumers can use it
|
||||||
|
for fail-fast checks, including downstream CLI validation commands, without
|
||||||
|
receiving a prepared snapshot.
|
||||||
|
|
||||||
|
The method shares `Prepare`'s request conversion and preparation path. Unlike
|
||||||
|
requirements inspection, it checks the actual supplied values and bindings.
|
||||||
|
Artifact and schema resource I/O still occurs; success does not certify provider
|
||||||
|
acceptance or later execution success. A subsequent run prepares independently.
|
||||||
|
Validation is optional, not a required step before preparation or execution.
|
||||||
|
|
||||||
|
See the [request validation guide](../consumers/pkg-promptkit.md#validate-a-concrete-request)
|
||||||
|
and [GoDoc](../../engine.go) for usage and the exact contract. Consumers that
|
||||||
|
need execution tied to a checked snapshot can use the existing
|
||||||
|
[prepared execution workflow](../consumers/pkg-promptkit.md#prepare-now-and-execute-the-same-snapshot-later).
|
||||||
|
|
||||||
|
## Compatibility And Upgrade
|
||||||
|
|
||||||
|
No application-code, configuration, or Go-toolchain migration is required from
|
||||||
|
v0.14.0. This is an optional API addition; existing inspection, preparation, and
|
||||||
|
execution workflows remain available.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
go get gitea.maximumdirect.net/eric/promptkit@v0.15.0
|
||||||
|
```
|
||||||
|
|
||||||
|
[COPYRIGHT](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.15.0/COPYRIGHT) | [LICENSE](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.15.0/LICENSE) | [ATTRIBUTION](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.15.0/docs/oss/attribution.md)
|
||||||
86
docs/releases/v0.16.0.md
Normal file
86
docs/releases/v0.16.0.md
Normal file
@@ -0,0 +1,86 @@
|
|||||||
|
# Promptkit v0.16.0
|
||||||
|
|
||||||
|
This release adds explicit smoke diagnostics, configuration collections,
|
||||||
|
namespace-scoped engine views, and expanded resource discovery. It also makes
|
||||||
|
intentional breaking changes to configuration ownership and prompt selection.
|
||||||
|
The minimum supported Go version remains 1.26.0.
|
||||||
|
|
||||||
|
## Configuration Collections And Discovery
|
||||||
|
|
||||||
|
Applications can compose caller-selected collections of backends, profiles,
|
||||||
|
and prompts. Collection resources have qualified identities such as
|
||||||
|
`support/answer`; root resources retain unqualified identities. `CollectionInput`
|
||||||
|
provides a convenience for mounting a selected ConfigKit input into a collection.
|
||||||
|
Promptkit now uses ConfigKit v0.8.0, including its optional source specification
|
||||||
|
header support.
|
||||||
|
|
||||||
|
`Engine.WithNamespaces` creates an immutable view with separate prompt, profile,
|
||||||
|
and backend scopes for short caller-supplied IDs. Views share the underlying
|
||||||
|
configuration, clients, capacity pools, and prepared-execution owner. Explicitly
|
||||||
|
qualified IDs and configured references keep their exact identities.
|
||||||
|
|
||||||
|
`ListProfiles` and `ListPrompts` support namespace filters. New `ListBackends`,
|
||||||
|
`ListNamespaces`, and `ListCollections` methods expose captured resource and
|
||||||
|
collection inventories. See the [collection format](../formats.md#source-headers-collections-and-resource-ids),
|
||||||
|
[scoped-view guide](../consumers/pkg-promptkit.md#use-scoped-engine-views), and
|
||||||
|
[discovery guide](../consumers/pkg-promptkit.md#discover-available-resources-and-collections).
|
||||||
|
|
||||||
|
## Explicit Smoke Diagnostics
|
||||||
|
|
||||||
|
`Engine.SmokeTest` provides backend reachability, authentication, text inference,
|
||||||
|
and structured-output inference diagnostics. Reports provide factual
|
||||||
|
observations, timing, and available usage rather than an overall readiness
|
||||||
|
verdict. Optional Boolean facts distinguish negative observations from unknown
|
||||||
|
or inapplicable checks; matching a JSON schema does not prove that a provider
|
||||||
|
enforced it.
|
||||||
|
|
||||||
|
A concluded diagnostic can report failure with a nil Go error. Invalid requests
|
||||||
|
return ordinary errors, and caller cancellation can return partial observations
|
||||||
|
with a recognizable context error. Diagnostics can contact providers and incur
|
||||||
|
inference costs only when explicitly invoked; they are not automatic execution
|
||||||
|
or release checks. See the [smoke diagnostic guide](../consumers/pkg-promptkit.md#run-explicit-smoke-diagnostics)
|
||||||
|
and [API GoDoc](../../smoke_diagnostics.go).
|
||||||
|
|
||||||
|
## Breaking Changes And Upgrade
|
||||||
|
|
||||||
|
Consumers upgrading from v0.15.0 should follow the
|
||||||
|
[configuration and API migration guide](../consumers/configuration-migration.md):
|
||||||
|
|
||||||
|
- Supply backend and profile definitions explicitly. Promptkit no longer bundles
|
||||||
|
provider catalogs or the `promptkit-openrouter-standard` and
|
||||||
|
`promptkit-openrouter-auto` profiles. Conventional backend names do not install
|
||||||
|
definitions automatically. Applications choose and maintain their sources.
|
||||||
|
- Convert version-keyed prompt mappings into one definition per prompt ID.
|
||||||
|
Prompt `version` is now an optional descriptive label, not a selector.
|
||||||
|
Choose deliberately which former definition to install.
|
||||||
|
- Remove `PromptVersion` selectors from `RunRequest`,
|
||||||
|
`RequirementInspectionRequest`, and `SmokeTestRequest`, where applicable.
|
||||||
|
Change prompt inspection calls to `InspectPrompt(ctx, promptID)`. Update code
|
||||||
|
consuming version-bearing inspection, identity, result, or observation fields
|
||||||
|
to handle optional labels, including nil and explicitly empty labels.
|
||||||
|
- When moving resources into collections, update stored backend, profile, and
|
||||||
|
diagnostic-default references to their intended qualified IDs. Mounting a
|
||||||
|
source does not rewrite references; profile inheritance remains within its
|
||||||
|
sibling mapping. Root configuration `version`, when supplied, is now a source
|
||||||
|
specification header, distinct from descriptive resource labels.
|
||||||
|
|
||||||
|
The migration guide includes identity mappings and before/after prompt examples.
|
||||||
|
The [maintained offline example](../../examples/go-library/prepare/main.go)
|
||||||
|
demonstrates explicit composition, source-relative content, scoped preparation,
|
||||||
|
and inventory without contacting a provider.
|
||||||
|
|
||||||
|
After adapting configuration and API calls:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
go get gitea.maximumdirect.net/eric/promptkit@v0.16.0
|
||||||
|
```
|
||||||
|
|
||||||
|
## Correctness And Efficiency
|
||||||
|
|
||||||
|
Collection prompt materialization shares one lazy origin-metadata snapshot,
|
||||||
|
avoiding repeated full metadata copies across collections. Internal prepared
|
||||||
|
snapshots detach optional prompt labels. Smoke diagnostics preserve caller
|
||||||
|
cancellation and report actual inference destinations and known-zero usage when
|
||||||
|
no generation request was dispatched.
|
||||||
|
|
||||||
|
[COPYRIGHT](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.16.0/COPYRIGHT) | [LICENSE](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.16.0/LICENSE) | [ATTRIBUTION](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.16.0/docs/oss/attribution.md)
|
||||||
68
docs/releases/v0.17.0.md
Normal file
68
docs/releases/v0.17.0.md
Normal file
@@ -0,0 +1,68 @@
|
|||||||
|
# Promptkit v0.17.0
|
||||||
|
|
||||||
|
This release adopts the vanity module path `go.maximumdirect.net/promptkit`
|
||||||
|
and ConfigKit v1.0.0, standardizes configuration resources as identified lists,
|
||||||
|
and removes descriptive prompt-version metadata. These are intentional breaking
|
||||||
|
changes before v1. The minimum supported Go version increases from 1.26.0 to
|
||||||
|
1.27.0 for the ConfigKit v1 migration.
|
||||||
|
|
||||||
|
## Breaking Changes And Upgrade
|
||||||
|
|
||||||
|
Consumers upgrading from v0.16.0 should follow the
|
||||||
|
[configuration and API migration guide](../consumers/configuration-migration.md):
|
||||||
|
|
||||||
|
- Change Promptkit imports from `gitea.maximumdirect.net/eric/promptkit` to
|
||||||
|
`go.maximumdirect.net/promptkit`. Update packages that exchange Promptkit
|
||||||
|
types together; old-path and vanity-path types are distinct.
|
||||||
|
- Change ConfigKit imports to `go.maximumdirect.net/configkit` at v1.0.0 and
|
||||||
|
adopt its renamed public inspection types and fields where used.
|
||||||
|
- Convert root and collection `prompts`, `profiles`, and `backends` from keyed
|
||||||
|
mappings to lists whose records contain an explicit `id`. Collections remain
|
||||||
|
keyed by namespace. Sibling inheritance now uses `extends: {id: parent}`;
|
||||||
|
later same-ID records replace lower records in full.
|
||||||
|
- Change `ProfileSource` and `BackendSource` calls to pass slices of
|
||||||
|
`ProfileConfig` and `BackendConfig`, setting each record's `ID`.
|
||||||
|
- Change source-root `configkit:` controls to `config:`. Imports are optional
|
||||||
|
unless marked `required: true`. Optional Promptkit specification headers now
|
||||||
|
use `version: 2` or `version: "2"`; headerless sources remain valid.
|
||||||
|
- Remove descriptive prompt `version` values and code consuming `PromptVersion`,
|
||||||
|
`PromptIdentity.Version`, or corresponding `prompt_version` output members.
|
||||||
|
Collection `release_version` labels remain available. Prompt hashes may change
|
||||||
|
across this migration.
|
||||||
|
|
||||||
|
After adapting Go imports, configuration, and API calls, use Go 1.27.0 or newer:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
go get go.maximumdirect.net/promptkit@v0.17.0
|
||||||
|
go mod tidy
|
||||||
|
```
|
||||||
|
|
||||||
|
Earlier tags retain their original module declarations. No permanent local
|
||||||
|
replacement is needed for this cutover. See the
|
||||||
|
[framework format reference](../formats.md) for current configuration semantics
|
||||||
|
and the [maintained preparation example](../../examples/go-library/prepare/main.go)
|
||||||
|
for explicit composition, source-relative imports, and scoped discovery.
|
||||||
|
|
||||||
|
## Configuration Inspection And Execution
|
||||||
|
|
||||||
|
Configuration inspection and diffs expose ConfigKit's composed values and
|
||||||
|
provenance, including list-index paths. Promptkit applies domain normalization
|
||||||
|
and execution defaults to owned interpretations without replacing the source
|
||||||
|
origins needed for relative resources. Profile inspection and preparation expose
|
||||||
|
their interpreted or effective settings. See the
|
||||||
|
[migration guide](../consumers/configuration-migration.md#select-and-compose-the-configuration-you-need)
|
||||||
|
for the distinction and inspection-path updates.
|
||||||
|
|
||||||
|
## Maintainer Tooling
|
||||||
|
|
||||||
|
Release tooling now uses the module-selected ReleaseKit v0.8.0 through `go tool`,
|
||||||
|
with page-only Gitea delivery and saved-publication-attempt recovery. The
|
||||||
|
[release procedure](../release.md) describes publication and recovery.
|
||||||
|
|
||||||
|
The three maintained offline examples now have ordinary Go workflow tests,
|
||||||
|
included in the standard suite. Their separate Python runner and custom release
|
||||||
|
hook have been removed; Python is no longer a normal release prerequisite.
|
||||||
|
The optional release-wiring diagnostic remains Python. See the
|
||||||
|
[development guide](../development.md#maintainer-validation).
|
||||||
|
|
||||||
|
[COPYRIGHT](https://forge.maximumdirect.net/base-layer/promptkit/src/tag/v0.17.0/COPYRIGHT) | [LICENSE](https://forge.maximumdirect.net/base-layer/promptkit/src/tag/v0.17.0/LICENSE) | [ATTRIBUTION](https://forge.maximumdirect.net/base-layer/promptkit/src/tag/v0.17.0/docs/oss/attribution.md)
|
||||||
@@ -63,8 +63,8 @@ Every engine now includes the reserved `rakestrawhome` backend, identified by
|
|||||||
selects that backend. Consumers can use the maintained endpoint, credential,
|
selects that backend. Consumers can use the maintained endpoint, credential,
|
||||||
capacity, and model defaults without registering either definition themselves.
|
capacity, and model defaults without registering either definition themselves.
|
||||||
|
|
||||||
See the [built-in backend and profile catalogs](../formats.md#built-in-backends)
|
See the [backend format reference](../formats.md#backend-definitions)
|
||||||
and the [consumer adoption example](../consumers/pkg-promptkit.md#use-the-rakestrawhome-built-in-profile)
|
and the [current identity migration mapping](../consumers/configuration-migration.md#identity-mapping)
|
||||||
for the current contracts.
|
for the current contracts.
|
||||||
|
|
||||||
## Structured Generation Errors
|
## Structured Generation Errors
|
||||||
@@ -126,8 +126,8 @@ cycle-safe, and resolved afresh for ordinary operations. Prepared execution
|
|||||||
freezes the fully resolved target. The selected leaf ID remains public while
|
freezes the fully resolved target. The selected leaf ID remains public while
|
||||||
effective execution settings reflect the resolved chain.
|
effective execution settings reflect the resolved chain.
|
||||||
|
|
||||||
See the [profile inheritance format reference](../formats.md#profile-inheritance),
|
See the [profile inheritance format reference](../formats.md#resource-inheritance),
|
||||||
the [consumer alias example](../consumers/pkg-promptkit.md#alias-a-built-in-profile),
|
the [current identity migration mapping](../consumers/configuration-migration.md#identity-mapping),
|
||||||
and the [`Profile` GoDoc](../../types.go) for exact merge and validation
|
and the [`Profile` GoDoc](../../types.go) for exact merge and validation
|
||||||
behavior.
|
behavior.
|
||||||
|
|
||||||
|
|||||||
@@ -96,9 +96,8 @@ precedence rules. Promptkit no longer keeps duplicate embedded profile assets
|
|||||||
or hard-coded definitions for those maintained backends.
|
or hard-coded definitions for those maintained backends.
|
||||||
|
|
||||||
The module versions in Promptkit's `go.mod` identify the catalog releases
|
The module versions in Promptkit's `go.mod` identify the catalog releases
|
||||||
tested with this release. The [built-in backend and profile format
|
tested with this release. The [backend format reference](../formats.md#backend-definitions)
|
||||||
reference](../formats.md#built-in-backends) remains the canonical consumer
|
remains the canonical consumer contract, while the [internal source documentation](../internal/sources.md#profiles)
|
||||||
contract, while the [internal source documentation](../internal/sources.md#profiles-and-built-ins)
|
|
||||||
describes the dependency boundary.
|
describes the dependency boundary.
|
||||||
|
|
||||||
## Public API Changes
|
## Public API Changes
|
||||||
|
|||||||
@@ -38,8 +38,30 @@ consumers.
|
|||||||
|
|
||||||
## Ideas
|
## Ideas
|
||||||
|
|
||||||
No ideas are currently awaiting selection. Active feature work belongs in its
|
### Field-Level Normalization With Preserved List Provenance
|
||||||
focused roadmap rather than this catalog.
|
|
||||||
|
Reevaluate normalizing resource fields directly in ConfigKit's effective
|
||||||
|
configuration after upstream ConfigKit supports recording changes within a
|
||||||
|
list without replacing the source attribution of unchanged fields.
|
||||||
|
|
||||||
|
This could let configuration inspection show PromptKit-normalized values and
|
||||||
|
field-level change history while preserving the origins needed to resolve
|
||||||
|
relative resources such as `content_file`. Assess whether that inspection
|
||||||
|
benefit justifies changing the execution-owned normalization approach.
|
||||||
|
|
||||||
|
Include normalization of roles and cache-control values in configured messages
|
||||||
|
in this reevaluation. This could make inspection reflect the values used for
|
||||||
|
execution and reduce separate normalization paths. Upstream support would need
|
||||||
|
to preserve untouched field origins within nested message lists as well as outer
|
||||||
|
resource lists. PromptKit would continue owning the normalization rules;
|
||||||
|
ConfigKit would record their effects and provenance. Caller-appended messages
|
||||||
|
would still need request-time normalization because they do not pass through
|
||||||
|
ConfigKit.
|
||||||
|
Consider moving these transformations only if it improves inspection consistency
|
||||||
|
and simplifies implementation without changing execution behavior.
|
||||||
|
|
||||||
|
Upstream support is the reconsideration trigger, not a dependency of the
|
||||||
|
current ConfigKit migration or a commitment to adopt the enhancement.
|
||||||
|
|
||||||
## Entry Format
|
## Entry Format
|
||||||
|
|
||||||
|
|||||||
103
engine.go
103
engine.go
@@ -8,11 +8,11 @@ import (
|
|||||||
"net/http"
|
"net/http"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/ConfigKit"
|
"go.maximumdirect.net/configkit"
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/domain"
|
"go.maximumdirect.net/promptkit/internal/domain"
|
||||||
internalengine "gitea.maximumdirect.net/eric/promptkit/internal/engine"
|
internalengine "go.maximumdirect.net/promptkit/internal/engine"
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/observation"
|
"go.maximumdirect.net/promptkit/internal/observation"
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/usecase"
|
"go.maximumdirect.net/promptkit/internal/usecase"
|
||||||
)
|
)
|
||||||
|
|
||||||
// ErrInvalidConfig identifies invalid engine construction, including missing
|
// ErrInvalidConfig identifies invalid engine construction, including missing
|
||||||
@@ -24,9 +24,8 @@ var (
|
|||||||
// ErrInvalidRequest identifies a request whose required values, overrides,
|
// ErrInvalidRequest identifies a request whose required values, overrides,
|
||||||
// credentials, or effective settings are invalid.
|
// credentials, or effective settings are invalid.
|
||||||
ErrInvalidRequest = errors.New("invalid run request")
|
ErrInvalidRequest = errors.New("invalid run request")
|
||||||
// ErrPromptNotFound identifies a requested prompt ID or version that is not
|
// ErrPromptNotFound identifies a requested prompt ID that is not present in
|
||||||
// present in the selected prompt source. It does not also match
|
// the captured configuration. It does not also match ErrPromptLoad.
|
||||||
// ErrPromptLoad.
|
|
||||||
ErrPromptNotFound = errors.New("prompt not found")
|
ErrPromptNotFound = errors.New("prompt not found")
|
||||||
// ErrProfileNotFound identifies a selected profile ID that is absent from
|
// ErrProfileNotFound identifies a selected profile ID that is absent from
|
||||||
// every configured profile source. It does not also match ErrProfileLoad.
|
// every configured profile source. It does not also match ErrProfileLoad.
|
||||||
@@ -85,13 +84,18 @@ var (
|
|||||||
// Engine inspects prompts and profiles, enumerates prompt requirements, and
|
// Engine inspects prompts and profiles, enumerates prompt requirements, and
|
||||||
// prepares and runs Promptkit prompt requests.
|
// prepares and runs Promptkit prompt requests.
|
||||||
//
|
//
|
||||||
// An Engine is safe for concurrent calls to [Engine.InspectConfiguration],
|
// An Engine is safe for concurrent calls to [Engine.WithNamespaces],
|
||||||
|
// [Engine.InspectConfiguration],
|
||||||
// [Engine.InspectPrompt],
|
// [Engine.InspectPrompt],
|
||||||
// [Engine.InspectRequirements], [Engine.InspectProfile], [Engine.Prepare], [Engine.PrepareExecution],
|
// [Engine.InspectRequirements], [Engine.InspectProfile], [Engine.Prepare], [Engine.PrepareExecution],
|
||||||
// [Engine.Run], and [Engine.RunPrepared]. Each Engine owns independent
|
// [Engine.Run], [Engine.RunPrepared], [Engine.SmokeTest], [Engine.ListProfiles],
|
||||||
// backend-capacity pools that coordinate Run and RunPrepared admission and
|
// [Engine.ListPrompts], [Engine.ListBackends], [Engine.ListNamespaces], and
|
||||||
// model generation. Injected collaborators may still be invoked concurrently
|
// [Engine.ListCollections]. Engines constructed separately by [NewEngine] own
|
||||||
// across different backend pools or for unlimited backends.
|
// independent backend-capacity pools that coordinate Run, RunPrepared, and
|
||||||
|
// inference SmokeTest admission and model generation. Namespace views returned
|
||||||
|
// by [Engine.WithNamespaces] share their underlying engine's pools, clients,
|
||||||
|
// and prepared-execution owner. Injected collaborators may still be invoked
|
||||||
|
// concurrently across different backend pools or for unlimited backends.
|
||||||
type Engine struct {
|
type Engine struct {
|
||||||
internal *internalengine.Engine
|
internal *internalengine.Engine
|
||||||
}
|
}
|
||||||
@@ -208,11 +212,11 @@ func WithSchemaFile(path string) Option {
|
|||||||
|
|
||||||
// NewEngine constructs an Engine from configuration and options.
|
// NewEngine constructs an Engine from configuration and options.
|
||||||
//
|
//
|
||||||
// ConfigKit composes maintained catalog inputs, PromptKit-owned definitions,
|
// ConfigKit composes caller-selected underlays in their given order, followed
|
||||||
// caller underlays, and the optional main input in that order. Construction
|
// by the optional main input. Construction validates the final effective
|
||||||
// validates the final effective backend, profile, and prompt definitions and
|
// backend, profile, and prompt definitions and captures referenced prompt
|
||||||
// captures referenced prompt content. A missing prompt collection is allowed.
|
// content. A missing prompt collection is allowed. Schema documents and
|
||||||
// Schema documents and request artifacts remain runtime resources.
|
// request artifacts remain runtime resources.
|
||||||
//
|
//
|
||||||
// NewEngine returns an error matching ErrInvalidConfig for invalid
|
// NewEngine returns an error matching ErrInvalidConfig for invalid
|
||||||
// configuration or options, preserving a ConfigKit LoadError when loading
|
// configuration or options, preserving a ConfigKit LoadError when loading
|
||||||
@@ -241,14 +245,13 @@ func NewEngine(cfg Config, opts ...Option) (*Engine, error) {
|
|||||||
return &Engine{internal: assembled}, nil
|
return &Engine{internal: assembled}, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// InspectPrompt resolves one explicit prompt definition without selecting a
|
// InspectPrompt resolves one prompt ID without selecting a profile or starting
|
||||||
// profile or starting execution work.
|
// execution work.
|
||||||
//
|
//
|
||||||
// InspectPrompt requires a nonblank promptID. It passes nonblank promptID and
|
// InspectPrompt requires a nonblank promptID and performs an exact,
|
||||||
// promptVersion values unchanged to the engine's ordinary, case-sensitive
|
// case-sensitive lookup in the captured configuration snapshot. A
|
||||||
// prompt selection. An empty version succeeds only when that ID has one
|
// namespace-scoped view qualifies slashless caller IDs before lookup; already
|
||||||
// version; a nonempty version selects one exact ID/version pair from the
|
// qualified IDs pass through.
|
||||||
// captured configuration snapshot.
|
|
||||||
//
|
//
|
||||||
// A successful result proves that the selected definition and any referenced
|
// A successful result proves that the selected definition and any referenced
|
||||||
// message content files were structurally loaded. Inputs are returned in
|
// message content files were structurally loaded. Inputs are returned in
|
||||||
@@ -267,21 +270,19 @@ func NewEngine(cfg Config, opts ...Option) (*Engine, error) {
|
|||||||
// or content files; construct another Engine to observe source changes.
|
// or content files; construct another Engine to observe source changes.
|
||||||
//
|
//
|
||||||
// A nil Engine returns an error matching ErrInvalidConfig. A blank prompt ID
|
// A nil Engine returns an error matching ErrInvalidConfig. A blank prompt ID
|
||||||
// matches ErrInvalidRequest. An absent exact ID or version matches
|
// matches ErrInvalidRequest. An absent exact ID matches ErrPromptNotFound and
|
||||||
// ErrPromptNotFound and not ErrPromptLoad. An ambiguous omitted version matches
|
// not ErrPromptLoad. Invalid definitions and resource failures reject
|
||||||
// ErrPromptLoad. Invalid definitions and resource failures reject construction
|
// construction instead. Cancellation during lookup preserves the context
|
||||||
// instead. Cancellation during lookup preserves the context error. InspectPrompt
|
// error. InspectPrompt returns no partial result on error.
|
||||||
// returns no partial result on error.
|
|
||||||
func (e *Engine) InspectPrompt(
|
func (e *Engine) InspectPrompt(
|
||||||
ctx context.Context,
|
ctx context.Context,
|
||||||
promptID string,
|
promptID string,
|
||||||
promptVersion string,
|
|
||||||
) (*PromptInspection, error) {
|
) (*PromptInspection, error) {
|
||||||
if e == nil || e.internal == nil {
|
if e == nil || e.internal == nil {
|
||||||
return nil, fmt.Errorf("%w: engine is nil", ErrInvalidConfig)
|
return nil, fmt.Errorf("%w: engine is nil", ErrInvalidConfig)
|
||||||
}
|
}
|
||||||
|
|
||||||
inspection, err := e.internal.InspectPrompt(ctx, promptID, promptVersion)
|
inspection, err := e.internal.InspectPrompt(ctx, promptID)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, mapPublicError(err)
|
return nil, mapPublicError(err)
|
||||||
}
|
}
|
||||||
@@ -346,6 +347,32 @@ func (e *Engine) InspectProfile(ctx context.Context, profileID string) (*Profile
|
|||||||
// relationship to ctx.Err is promised. Prepare returns no partial result on
|
// relationship to ctx.Err is promised. Prepare returns no partial result on
|
||||||
// error. It validates RunRequest.TransientRetries but makes no model attempts.
|
// error. It validates RunRequest.TransientRetries but makes no model attempts.
|
||||||
func (e *Engine) Prepare(ctx context.Context, req RunRequest) (*PreparedRun, error) {
|
func (e *Engine) Prepare(ctx context.Context, req RunRequest) (*PreparedRun, error) {
|
||||||
|
prepared, err := e.prepareRequest(ctx, req)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return fromDomainPreparedRun(prepared), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ValidateRequest reports whether req passes the same preparation path used by
|
||||||
|
// [Engine.Prepare] at the time of this call. A nil error means this concrete
|
||||||
|
// request passed preparation. It checks only this invocation and returns errors
|
||||||
|
// as encountered rather than aggregating them. All supplied inputs follow the
|
||||||
|
// same loading behavior as [Engine.Prepare], including inputs unused by the
|
||||||
|
// selected template branch. The method does not call an LLM or retain a
|
||||||
|
// prepared snapshot or executable handle, but preparation may still perform
|
||||||
|
// resource I/O and incur its associated time and memory costs.
|
||||||
|
//
|
||||||
|
// Its errors and context handling follow [Engine.Prepare], including an error
|
||||||
|
// matching ErrInvalidConfig when the Engine is nil. Success does not guarantee
|
||||||
|
// provider acceptance or later execution success. Use [Engine.PrepareExecution]
|
||||||
|
// when execution must use the snapshot produced by preparation.
|
||||||
|
func (e *Engine) ValidateRequest(ctx context.Context, req RunRequest) error {
|
||||||
|
_, err := e.prepareRequest(ctx, req)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
func (e *Engine) prepareRequest(ctx context.Context, req RunRequest) (*domain.PreparedRun, error) {
|
||||||
ctx = observation.WithoutExecutionState(ctx)
|
ctx = observation.WithoutExecutionState(ctx)
|
||||||
if e == nil || e.internal == nil {
|
if e == nil || e.internal == nil {
|
||||||
return nil, fmt.Errorf("%w: engine is nil", ErrInvalidConfig)
|
return nil, fmt.Errorf("%w: engine is nil", ErrInvalidConfig)
|
||||||
@@ -360,15 +387,16 @@ func (e *Engine) Prepare(ctx context.Context, req RunRequest) (*PreparedRun, err
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, mapPublicError(err)
|
return nil, mapPublicError(err)
|
||||||
}
|
}
|
||||||
return fromDomainPreparedRun(prepared), nil
|
return prepared, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// PrepareExecution completely prepares a prompt request without calling the
|
// PrepareExecution completely prepares a prompt request without calling the
|
||||||
// configured LLMClient or reserving backend admission capacity. Validated
|
// configured LLMClient or reserving backend admission capacity. Validated
|
||||||
// RunRequest.AppendedMessages are included in the frozen effective messages.
|
// RunRequest.AppendedMessages are included in the frozen effective messages.
|
||||||
//
|
//
|
||||||
// The returned opaque handle is bound to this Engine and permits one
|
// The returned opaque handle is bound to this Engine's underlying execution
|
||||||
// [Engine.RunPrepared] invocation. Preparation freezes the selected sources,
|
// owner, shared with its namespace views, and permits one [Engine.RunPrepared]
|
||||||
|
// invocation in total. Preparation freezes the selected sources,
|
||||||
// rendered messages, effective settings, inputs, provider structured-output
|
// rendered messages, effective settings, inputs, provider structured-output
|
||||||
// metadata, and validation resources needed by that invocation. The handle
|
// metadata, and validation resources needed by that invocation. The handle
|
||||||
// retains a direct RunRequest.APIKey only in private execution state;
|
// retains a direct RunRequest.APIKey only in private execution state;
|
||||||
@@ -480,6 +508,11 @@ func (e *Engine) run(ctx context.Context, req RunRequest) (*RunResult, error) {
|
|||||||
// RunPrepared atomically claims and executes a handle created by
|
// RunPrepared atomically claims and executes a handle created by
|
||||||
// [Engine.PrepareExecution].
|
// [Engine.PrepareExecution].
|
||||||
//
|
//
|
||||||
|
// The originating Engine and namespace views sharing its underlying owner may
|
||||||
|
// claim the handle. Execution uses its captured selections without applying the
|
||||||
|
// invoking view's namespaces. An Engine constructed separately by [NewEngine]
|
||||||
|
// is a foreign owner.
|
||||||
|
//
|
||||||
// A valid owning-Engine invocation consumes the handle's one attempt before
|
// A valid owning-Engine invocation consumes the handle's one attempt before
|
||||||
// credential revalidation, backend admission, generation, or validation.
|
// credential revalidation, backend admission, generation, or validation.
|
||||||
// Cancellation, capacity rejection, generation failure, operational
|
// Cancellation, capacity rejection, generation failure, operational
|
||||||
|
|||||||
12
errors.go
12
errors.go
@@ -5,12 +5,12 @@ import (
|
|||||||
"fmt"
|
"fmt"
|
||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/capacity"
|
"go.maximumdirect.net/promptkit/internal/capacity"
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/generation"
|
"go.maximumdirect.net/promptkit/internal/generation"
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/llm"
|
"go.maximumdirect.net/promptkit/internal/llm"
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/profile"
|
"go.maximumdirect.net/promptkit/internal/profile"
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/promptdef"
|
"go.maximumdirect.net/promptkit/internal/promptdef"
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/usecase"
|
"go.maximumdirect.net/promptkit/internal/usecase"
|
||||||
)
|
)
|
||||||
|
|
||||||
func mapPublicError(err error) error {
|
func mapPublicError(err error) error {
|
||||||
|
|||||||
@@ -6,8 +6,8 @@ import (
|
|||||||
"fmt"
|
"fmt"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/llm"
|
"go.maximumdirect.net/promptkit/internal/llm"
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/usecase"
|
"go.maximumdirect.net/promptkit/internal/usecase"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestMapPublicErrorPreservesGenerationCancellation(t *testing.T) {
|
func TestMapPublicErrorPreservesGenerationCancellation(t *testing.T) {
|
||||||
|
|||||||
@@ -10,8 +10,8 @@ import (
|
|||||||
"os"
|
"os"
|
||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/ConfigKit"
|
"go.maximumdirect.net/configkit"
|
||||||
"gitea.maximumdirect.net/eric/promptkit"
|
"go.maximumdirect.net/promptkit"
|
||||||
)
|
)
|
||||||
|
|
||||||
//go:embed prompts/*.yaml schemas/*.json
|
//go:embed prompts/*.yaml schemas/*.json
|
||||||
@@ -84,13 +84,15 @@ func run() (summary, error) {
|
|||||||
return summary{}, err
|
return summary{}, err
|
||||||
}
|
}
|
||||||
backendID, proposalModel, assessmentModel := "offline-backend", "proposal-model", "assessment-model"
|
backendID, proposalModel, assessmentModel := "offline-backend", "proposal-model", "assessment-model"
|
||||||
|
backend := promptkit.LocalBackend("https://example.invalid/v1", 1)
|
||||||
|
backend.ID = backendID
|
||||||
inputs = append(inputs,
|
inputs = append(inputs,
|
||||||
configkit.Input{Source: promptkit.BackendSource("example backend", map[string]promptkit.BackendConfig{
|
configkit.Input{Source: promptkit.BackendSource("example backend", []promptkit.BackendConfig{
|
||||||
backendID: promptkit.LocalBackend("https://example.invalid/v1", 1),
|
backend,
|
||||||
})},
|
})},
|
||||||
configkit.Input{Source: promptkit.ProfileSource("example profiles", map[string]promptkit.ProfileConfig{
|
configkit.Input{Source: promptkit.ProfileSource("example profiles", []promptkit.ProfileConfig{
|
||||||
"proposal-profile": {Backend: &backendID, Model: &proposalModel},
|
{ID: "proposal-profile", Backend: &backendID, Model: &proposalModel},
|
||||||
"assessment-profile": {Backend: &backendID, Model: &assessmentModel},
|
{ID: "assessment-profile", Backend: &backendID, Model: &assessmentModel},
|
||||||
})},
|
})},
|
||||||
)
|
)
|
||||||
engine, err := promptkit.NewEngine(promptkit.Config{
|
engine, err := promptkit.NewEngine(promptkit.Config{
|
||||||
@@ -156,13 +158,16 @@ func run() (summary, error) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func main() {
|
func main() {
|
||||||
value, err := run()
|
if err := execute(os.Stdout); err != nil {
|
||||||
if err != nil {
|
|
||||||
fmt.Fprintln(os.Stderr, err)
|
|
||||||
os.Exit(1)
|
|
||||||
}
|
|
||||||
if err := json.NewEncoder(os.Stdout).Encode(value); err != nil {
|
|
||||||
fmt.Fprintln(os.Stderr, err)
|
fmt.Fprintln(os.Stderr, err)
|
||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func execute(out io.Writer) error {
|
||||||
|
value, err := run()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return json.NewEncoder(out).Encode(value)
|
||||||
|
}
|
||||||
|
|||||||
30
examples/go-library/observe/main_test.go
Normal file
30
examples/go-library/observe/main_test.go
Normal file
@@ -0,0 +1,30 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"encoding/json"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestObserveExample(t *testing.T) {
|
||||||
|
var output bytes.Buffer
|
||||||
|
if err := execute(&output); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
var got struct {
|
||||||
|
ProposalAttempts *int `json:"proposal_attempts"`
|
||||||
|
ProposalRetries *int `json:"proposal_transient_retries"`
|
||||||
|
UsageComplete *bool `json:"proposal_usage_complete"`
|
||||||
|
AssessmentAttempts *int `json:"assessment_attempts"`
|
||||||
|
AssessmentRetries *int `json:"assessment_transient_retries"`
|
||||||
|
Outcome string `json:"assessment_outcome"`
|
||||||
|
}
|
||||||
|
if err := json.Unmarshal(output.Bytes(), &got); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if got.ProposalAttempts == nil || *got.ProposalAttempts != 2 || got.ProposalRetries == nil || *got.ProposalRetries != 1 ||
|
||||||
|
got.UsageComplete == nil || *got.UsageComplete || got.AssessmentAttempts == nil || *got.AssessmentAttempts != 1 ||
|
||||||
|
got.AssessmentRetries == nil || *got.AssessmentRetries != 0 || got.Outcome != "accepted" {
|
||||||
|
t.Fatalf("unexpected observation summary: %+v", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,18 +1,17 @@
|
|||||||
prompts:
|
prompts:
|
||||||
example.assessment:
|
- id: example.assessment
|
||||||
"1.0.0":
|
default_profile: assessment-profile
|
||||||
default_profile: assessment-profile
|
description: Assess a structured proposal independently of schema validity.
|
||||||
description: Assess a structured proposal independently of schema validity.
|
inputs:
|
||||||
inputs:
|
- name: proposal
|
||||||
- name: proposal
|
required: true
|
||||||
required: true
|
content_type: application/json
|
||||||
content_type: application/json
|
messages:
|
||||||
messages:
|
- role: system
|
||||||
- role: system
|
content: Return a concise assessment as JSON.
|
||||||
content: Return a concise assessment as JSON.
|
- role: user
|
||||||
- role: user
|
content: '{{input "proposal"}}'
|
||||||
content: '{{input "proposal"}}'
|
output:
|
||||||
output:
|
format: json
|
||||||
format: json
|
validation_mode: json_schema
|
||||||
validation_mode: json_schema
|
schema_path: assessment.schema.json
|
||||||
schema_path: assessment.schema.json
|
|
||||||
|
|||||||
@@ -1,18 +1,17 @@
|
|||||||
prompts:
|
prompts:
|
||||||
example.proposal:
|
- id: example.proposal
|
||||||
"1.0.0":
|
default_profile: proposal-profile
|
||||||
default_profile: proposal-profile
|
description: Propose a bounded improvement from a synthetic idea.
|
||||||
description: Propose a bounded improvement from a synthetic idea.
|
inputs:
|
||||||
inputs:
|
- name: idea
|
||||||
- name: idea
|
required: true
|
||||||
required: true
|
content_type: text/plain
|
||||||
content_type: text/plain
|
messages:
|
||||||
messages:
|
- role: system
|
||||||
- role: system
|
content: Return a concise proposal as JSON.
|
||||||
content: Return a concise proposal as JSON.
|
- role: user
|
||||||
- role: user
|
content: '{{input "idea"}}'
|
||||||
content: '{{input "idea"}}'
|
output:
|
||||||
output:
|
format: json
|
||||||
format: json
|
validation_mode: json_schema
|
||||||
validation_mode: json_schema
|
schema_path: proposal.schema.json
|
||||||
schema_path: proposal.schema.json
|
|
||||||
|
|||||||
@@ -0,0 +1,17 @@
|
|||||||
|
backends:
|
||||||
|
- id: offline
|
||||||
|
endpoint: https://review.example.invalid/v1
|
||||||
|
profiles:
|
||||||
|
- id: audit
|
||||||
|
backend: review/offline
|
||||||
|
model: review-model
|
||||||
|
prompts:
|
||||||
|
- id: check
|
||||||
|
default_profile: review/audit
|
||||||
|
description: Inspect a review item without contacting a model provider.
|
||||||
|
messages:
|
||||||
|
- role: user
|
||||||
|
content: Review the supplied synthetic example.
|
||||||
|
output:
|
||||||
|
format: text
|
||||||
|
validation_mode: none
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
version: "2"
|
||||||
|
config:
|
||||||
|
imports:
|
||||||
|
- path: fragments/resources.yaml
|
||||||
|
required: true
|
||||||
|
- path: fragments/prepare.yaml
|
||||||
|
destination: [prompts]
|
||||||
|
placement: sequence-item
|
||||||
|
required: true
|
||||||
|
release_version: "1.4.0"
|
||||||
@@ -0,0 +1,15 @@
|
|||||||
|
id: prepare
|
||||||
|
default_profile: support/fast
|
||||||
|
description: Prepare a prompt without contacting a model provider.
|
||||||
|
inputs:
|
||||||
|
- name: note
|
||||||
|
required: true
|
||||||
|
content_type: text/plain
|
||||||
|
messages:
|
||||||
|
- role: system
|
||||||
|
content: Summarize the note in one sentence.
|
||||||
|
- role: user
|
||||||
|
content_file: ../messages/note.md
|
||||||
|
output:
|
||||||
|
format: text
|
||||||
|
validation_mode: basic
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
backends:
|
||||||
|
- id: offline
|
||||||
|
endpoint: https://example.invalid/v1
|
||||||
|
profiles:
|
||||||
|
- id: base
|
||||||
|
backend: support/offline
|
||||||
|
model: offline-model
|
||||||
|
timeout_seconds: 90
|
||||||
|
- id: fast
|
||||||
|
extends: {id: base}
|
||||||
|
timeout_seconds: 60
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
{{input "note"}}
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
# A later input replaces the profile with an inherited variant.
|
||||||
|
profiles:
|
||||||
|
- id: fast
|
||||||
|
extends: {id: base}
|
||||||
|
timeout_seconds: 30
|
||||||
@@ -4,74 +4,162 @@ import (
|
|||||||
"context"
|
"context"
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"io"
|
||||||
"os"
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/ConfigKit"
|
"go.maximumdirect.net/configkit"
|
||||||
"gitea.maximumdirect.net/eric/promptkit"
|
"go.maximumdirect.net/promptkit"
|
||||||
)
|
)
|
||||||
|
|
||||||
type summary struct {
|
type summary struct {
|
||||||
PromptID string `json:"prompt_id"`
|
PromptID string `json:"prompt_id"`
|
||||||
PromptVersion string `json:"prompt_version"`
|
SelectedProfile string `json:"selected_profile"`
|
||||||
SelectedProfile string `json:"selected_profile"`
|
Model string `json:"model"`
|
||||||
Model string `json:"model"`
|
MessageCount int `json:"message_count"`
|
||||||
MessageCount int `json:"message_count"`
|
ProfileTimeout int `json:"profile_timeout_seconds"`
|
||||||
|
Namespaces []string `json:"namespaces"`
|
||||||
|
Collections []collectionSummary `json:"collections"`
|
||||||
|
ScopedPrompts []string `json:"scoped_prompts"`
|
||||||
|
ReviewPrompts []string `json:"review_prompts"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type collectionSummary struct {
|
||||||
|
Namespace string `json:"namespace"`
|
||||||
|
ReleaseVersion *string `json:"release_version"`
|
||||||
}
|
}
|
||||||
|
|
||||||
func main() {
|
func main() {
|
||||||
endpoint, model := "https://example.invalid/v1", "offline-model"
|
if err := run(context.Background(), "examples/go-library/prepare", os.Stdout); err != nil {
|
||||||
|
fmt.Fprintln(os.Stderr, err)
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func run(ctx context.Context, exampleDir string, out io.Writer) error {
|
||||||
|
support, err := promptkit.CollectionInput(
|
||||||
|
"support",
|
||||||
|
configkit.File(filepath.Join(exampleDir, "collections", "support", "collection.yaml")),
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
review, err := promptkit.CollectionInput(
|
||||||
|
"review",
|
||||||
|
configkit.File(filepath.Join(exampleDir, "collections", "review", "collection.yaml")),
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
override, err := promptkit.CollectionInput(
|
||||||
|
"support",
|
||||||
|
configkit.File(filepath.Join(exampleDir, "collections", "support", "operator-overrides.yaml")),
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
engine, err := promptkit.NewEngine(promptkit.Config{Sources: promptkit.ConfigurationSources{
|
engine, err := promptkit.NewEngine(promptkit.Config{Sources: promptkit.ConfigurationSources{
|
||||||
Underlays: []configkit.Underlay{{Inputs: []configkit.Input{{Source: promptkit.ProfileSource("example profile", map[string]promptkit.ProfileConfig{
|
Underlays: []configkit.Underlay{
|
||||||
"offline-example": {Endpoint: &endpoint, Model: &model},
|
{Inputs: []configkit.Input{support, review}},
|
||||||
})}}}},
|
{Inputs: []configkit.Input{override}},
|
||||||
Main: &configkit.Input{Source: configkit.File("examples/go-library/prepare/prompt.yaml")},
|
},
|
||||||
}})
|
}})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
exit(err)
|
return err
|
||||||
|
}
|
||||||
|
scoped, err := engine.WithNamespaces(promptkit.Namespaces{
|
||||||
|
Prompt: "support", Profile: "support", Backend: "support",
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
}
|
}
|
||||||
view, err := engine.InspectConfiguration()
|
view, err := engine.InspectConfiguration()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
exit(err)
|
return err
|
||||||
}
|
}
|
||||||
if _, found := view.Explain(configkit.Keys("profiles", "offline-example", "model")); !found {
|
if _, found := view.Explain(configkit.Keys("collections", "support", "profiles").Index(1).Key("timeout_seconds")); !found {
|
||||||
exit(fmt.Errorf("configured profile model was not found"))
|
return fmt.Errorf("collection profile override was not found")
|
||||||
}
|
}
|
||||||
requirements, err := engine.InspectRequirements(context.Background(), promptkit.RequirementInspectionRequest{
|
requirements, err := scoped.InspectRequirements(ctx, promptkit.RequirementInspectionRequest{
|
||||||
PromptID: "example.prepare",
|
PromptID: "prepare",
|
||||||
})
|
})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
exit(err)
|
return err
|
||||||
}
|
}
|
||||||
if !requirements.Complete || len(requirements.Inputs) != 1 ||
|
if !requirements.Complete || len(requirements.Inputs) != 1 ||
|
||||||
requirements.Inputs[0].Name != "note" ||
|
requirements.Inputs[0].Name != "note" ||
|
||||||
requirements.Inputs[0].Kind != promptkit.RequirementRequired {
|
requirements.Inputs[0].Kind != promptkit.RequirementRequired {
|
||||||
exit(fmt.Errorf("required note input was not discovered before preparation"))
|
return fmt.Errorf("required note input was not discovered before preparation")
|
||||||
}
|
}
|
||||||
|
|
||||||
prepared, err := engine.Prepare(context.Background(), promptkit.RunRequest{
|
request := promptkit.RunRequest{
|
||||||
PromptID: "example.prepare",
|
PromptID: "prepare",
|
||||||
|
ProfileID: "fast",
|
||||||
Inputs: map[string]promptkit.ArtifactRef{
|
Inputs: map[string]promptkit.ArtifactRef{
|
||||||
"note": promptkit.Inline("Ada finished the migration review."),
|
"note": promptkit.Inline("Ada finished the migration review."),
|
||||||
},
|
},
|
||||||
|
}
|
||||||
|
if err := scoped.ValidateRequest(ctx, request); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
prepared, err := scoped.Prepare(ctx, request)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
profile, err := scoped.InspectProfile(ctx, "fast")
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if profile.EffectiveModelParams.TimeoutSeconds != 30 {
|
||||||
|
return fmt.Errorf(
|
||||||
|
"later profile override was not applied: timeout is %d seconds",
|
||||||
|
profile.EffectiveModelParams.TimeoutSeconds,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
namespaces, err := scoped.ListNamespaces(ctx)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
collections, err := scoped.ListCollections(ctx)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
scopedPrompts, err := scoped.ListPrompts(ctx)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
reviewPrompts, err := scoped.ListPrompts(ctx, promptkit.NamespaceFilter{
|
||||||
|
Mode: promptkit.NamespaceNamed, Name: "review",
|
||||||
})
|
})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
exit(err)
|
return err
|
||||||
|
}
|
||||||
|
scopedPromptIDs := make([]string, len(scopedPrompts))
|
||||||
|
for index := range scopedPrompts {
|
||||||
|
scopedPromptIDs[index] = scopedPrompts[index].ID
|
||||||
|
}
|
||||||
|
reviewPromptIDs := make([]string, len(reviewPrompts))
|
||||||
|
for index := range reviewPrompts {
|
||||||
|
reviewPromptIDs[index] = reviewPrompts[index].ID
|
||||||
|
}
|
||||||
|
collectionSummaries := make([]collectionSummary, len(collections))
|
||||||
|
for index := range collections {
|
||||||
|
collectionSummaries[index] = collectionSummary{
|
||||||
|
Namespace: collections[index].Namespace, ReleaseVersion: collections[index].ReleaseVersion,
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
encoder := json.NewEncoder(os.Stdout)
|
encoder := json.NewEncoder(out)
|
||||||
encoder.SetIndent("", " ")
|
encoder.SetIndent("", " ")
|
||||||
if err := encoder.Encode(summary{
|
return encoder.Encode(summary{
|
||||||
PromptID: prepared.PromptID,
|
PromptID: prepared.PromptID,
|
||||||
PromptVersion: prepared.PromptVersion,
|
|
||||||
SelectedProfile: prepared.SelectedProfileID,
|
SelectedProfile: prepared.SelectedProfileID,
|
||||||
Model: prepared.EffectiveModelParams.Model,
|
Model: prepared.EffectiveModelParams.Model,
|
||||||
MessageCount: len(prepared.Messages),
|
MessageCount: len(prepared.Messages),
|
||||||
}); err != nil {
|
ProfileTimeout: profile.EffectiveModelParams.TimeoutSeconds,
|
||||||
exit(err)
|
Namespaces: namespaces,
|
||||||
}
|
Collections: collectionSummaries,
|
||||||
}
|
ScopedPrompts: scopedPromptIDs,
|
||||||
|
ReviewPrompts: reviewPromptIDs,
|
||||||
func exit(err error) {
|
})
|
||||||
fmt.Fprintln(os.Stderr, err)
|
|
||||||
os.Exit(1)
|
|
||||||
}
|
}
|
||||||
|
|||||||
45
examples/go-library/prepare/main_test.go
Normal file
45
examples/go-library/prepare/main_test.go
Normal file
@@ -0,0 +1,45 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"encoding/json"
|
||||||
|
"reflect"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestPrepareExample(t *testing.T) {
|
||||||
|
var output bytes.Buffer
|
||||||
|
if err := run(t.Context(), ".", &output); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
var got struct {
|
||||||
|
PromptID string `json:"prompt_id"`
|
||||||
|
Profile string `json:"selected_profile"`
|
||||||
|
Model string `json:"model"`
|
||||||
|
MessageCount int `json:"message_count"`
|
||||||
|
Timeout int `json:"profile_timeout_seconds"`
|
||||||
|
Namespaces []string `json:"namespaces"`
|
||||||
|
Collections []map[string]json.RawMessage `json:"collections"`
|
||||||
|
ScopedPrompts []string `json:"scoped_prompts"`
|
||||||
|
ReviewPrompts []string `json:"review_prompts"`
|
||||||
|
}
|
||||||
|
if err := json.Unmarshal(output.Bytes(), &got); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if got.PromptID != "support/prepare" || got.Profile != "support/fast" || got.Model != "offline-model" ||
|
||||||
|
got.MessageCount <= 0 || got.Timeout != 30 || !reflect.DeepEqual(got.Namespaces, []string{"review", "support"}) ||
|
||||||
|
!reflect.DeepEqual(got.ScopedPrompts, []string{"support/prepare"}) || !reflect.DeepEqual(got.ReviewPrompts, []string{"review/check"}) || len(got.Collections) != 2 {
|
||||||
|
t.Fatalf("unexpected preparation summary: %+v", got)
|
||||||
|
}
|
||||||
|
for index, want := range []struct{ namespace, release string }{{"review", ""}, {"support", "1.4.0"}} {
|
||||||
|
var namespace string
|
||||||
|
if err := json.Unmarshal(got.Collections[index]["namespace"], &namespace); err != nil || namespace != want.namespace {
|
||||||
|
t.Fatalf("collection namespace = %q, %v", namespace, err)
|
||||||
|
}
|
||||||
|
value, present := got.Collections[index]["release_version"]
|
||||||
|
var release *string
|
||||||
|
if !present || json.Unmarshal(value, &release) != nil || (index == 0 && release != nil) || (index == 1 && (release == nil || *release != want.release)) {
|
||||||
|
t.Fatalf("collection release = %s, present %t; want %q", value, present, want.release)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
prompts:
|
|
||||||
example.prepare:
|
|
||||||
"1.0.0":
|
|
||||||
default_profile: offline-example
|
|
||||||
description: Prepare a prompt without contacting a model provider.
|
|
||||||
inputs:
|
|
||||||
- name: note
|
|
||||||
required: true
|
|
||||||
content_type: text/plain
|
|
||||||
messages:
|
|
||||||
- role: system
|
|
||||||
content: Summarize the note in one sentence.
|
|
||||||
- role: user
|
|
||||||
content: '{{input "note"}}'
|
|
||||||
output:
|
|
||||||
format: text
|
|
||||||
validation_mode: basic
|
|
||||||
@@ -4,10 +4,12 @@ import (
|
|||||||
"context"
|
"context"
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"io"
|
||||||
"os"
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/ConfigKit"
|
"go.maximumdirect.net/configkit"
|
||||||
"gitea.maximumdirect.net/eric/promptkit"
|
"go.maximumdirect.net/promptkit"
|
||||||
)
|
)
|
||||||
|
|
||||||
type deterministicClient struct{}
|
type deterministicClient struct{}
|
||||||
@@ -39,41 +41,41 @@ type summary struct {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func main() {
|
func main() {
|
||||||
|
if err := run(context.Background(), "examples/go-library/run", os.Stdout); err != nil {
|
||||||
|
fmt.Fprintln(os.Stderr, err)
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func run(ctx context.Context, exampleDir string, out io.Writer) error {
|
||||||
endpoint, model := "https://example.invalid/v1", "offline-model"
|
endpoint, model := "https://example.invalid/v1", "offline-model"
|
||||||
engine, err := promptkit.NewEngine(promptkit.Config{Sources: promptkit.ConfigurationSources{
|
engine, err := promptkit.NewEngine(promptkit.Config{Sources: promptkit.ConfigurationSources{
|
||||||
Underlays: []configkit.Underlay{{Inputs: []configkit.Input{{Source: promptkit.ProfileSource("example profile", map[string]promptkit.ProfileConfig{
|
Underlays: []configkit.Underlay{{Inputs: []configkit.Input{{Source: promptkit.ProfileSource("example profile", []promptkit.ProfileConfig{
|
||||||
"offline-example": {Endpoint: &endpoint, Model: &model},
|
{ID: "offline-example", Endpoint: &endpoint, Model: &model},
|
||||||
})}}}},
|
})}}}},
|
||||||
Main: &configkit.Input{Source: configkit.File("examples/go-library/run/prompt.yaml")},
|
Main: &configkit.Input{Source: configkit.File(filepath.Join(exampleDir, "prompt.yaml"))},
|
||||||
}}, promptkit.WithLLMClient(deterministicClient{}))
|
}}, promptkit.WithLLMClient(deterministicClient{}))
|
||||||
if err != nil {
|
if err != nil {
|
||||||
exit(err)
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
result, err := engine.Run(context.Background(), promptkit.RunRequest{
|
result, err := engine.Run(ctx, promptkit.RunRequest{
|
||||||
PromptID: "example.run",
|
PromptID: "example.run",
|
||||||
Inputs: map[string]promptkit.ArtifactRef{
|
Inputs: map[string]promptkit.ArtifactRef{
|
||||||
"note": promptkit.Inline("Ada finished the migration review."),
|
"note": promptkit.Inline("Ada finished the migration review."),
|
||||||
},
|
},
|
||||||
})
|
})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
exit(err)
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
encoder := json.NewEncoder(os.Stdout)
|
encoder := json.NewEncoder(out)
|
||||||
encoder.SetIndent("", " ")
|
encoder.SetIndent("", " ")
|
||||||
if err := encoder.Encode(summary{
|
return encoder.Encode(summary{
|
||||||
Output: result.RawOutput,
|
Output: result.RawOutput,
|
||||||
ValidationStatus: result.Validation.Status,
|
ValidationStatus: result.Validation.Status,
|
||||||
IsValid: result.Validation.IsValid,
|
IsValid: result.Validation.IsValid,
|
||||||
Model: result.ModelName,
|
Model: result.ModelName,
|
||||||
TotalTokens: result.Usage.TotalTokens,
|
TotalTokens: result.Usage.TotalTokens,
|
||||||
}); err != nil {
|
})
|
||||||
exit(err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func exit(err error) {
|
|
||||||
fmt.Fprintln(os.Stderr, err)
|
|
||||||
os.Exit(1)
|
|
||||||
}
|
}
|
||||||
|
|||||||
28
examples/go-library/run/main_test.go
Normal file
28
examples/go-library/run/main_test.go
Normal file
@@ -0,0 +1,28 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"encoding/json"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestRunExample(t *testing.T) {
|
||||||
|
var output bytes.Buffer
|
||||||
|
if err := run(t.Context(), ".", &output); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
var got struct {
|
||||||
|
Output string `json:"output"`
|
||||||
|
Valid *bool `json:"is_valid"`
|
||||||
|
Status string `json:"validation_status"`
|
||||||
|
Model string `json:"model"`
|
||||||
|
Tokens *int `json:"total_tokens"`
|
||||||
|
}
|
||||||
|
if err := json.Unmarshal(output.Bytes(), &got); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if got.Output != "Ada finished the migration review." || got.Valid == nil || !*got.Valid ||
|
||||||
|
got.Status != "passed" || got.Model != "offline-model" || got.Tokens == nil || *got.Tokens != 18 {
|
||||||
|
t.Fatalf("unexpected execution summary: %+v", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,17 +1,16 @@
|
|||||||
prompts:
|
prompts:
|
||||||
example.run:
|
- id: example.run
|
||||||
"1.0.0":
|
default_profile: offline-example
|
||||||
default_profile: offline-example
|
description: Run a prompt with a deterministic injected model client.
|
||||||
description: Run a prompt with a deterministic injected model client.
|
inputs:
|
||||||
inputs:
|
- name: note
|
||||||
- name: note
|
required: true
|
||||||
required: true
|
content_type: text/plain
|
||||||
content_type: text/plain
|
messages:
|
||||||
messages:
|
- role: system
|
||||||
- role: system
|
content: Summarize the note in one sentence.
|
||||||
content: Summarize the note in one sentence.
|
- role: user
|
||||||
- role: user
|
content: '{{input "note"}}'
|
||||||
content: '{{input "note"}}'
|
output:
|
||||||
output:
|
format: text
|
||||||
format: text
|
validation_mode: basic
|
||||||
validation_mode: basic
|
|
||||||
|
|||||||
@@ -18,9 +18,8 @@ func (r RunRequest) GoString() string {
|
|||||||
|
|
||||||
func (r RunRequest) redactedString() string {
|
func (r RunRequest) redactedString() string {
|
||||||
return fmt.Sprintf(
|
return fmt.Sprintf(
|
||||||
"promptkit.RunRequest{PromptID:%q PromptVersion:%q ProfileID:%q APIKeySet:%t Inputs:%d Vars:%d ExecutionSet:%t ValidationSet:%t AppendedMessages:%d}",
|
"promptkit.RunRequest{PromptID:%q ProfileID:%q APIKeySet:%t Inputs:%d Vars:%d ExecutionSet:%t ValidationSet:%t AppendedMessages:%d}",
|
||||||
r.PromptID,
|
r.PromptID,
|
||||||
r.PromptVersion,
|
|
||||||
r.ProfileID,
|
r.ProfileID,
|
||||||
r.APIKey != "",
|
r.APIKey != "",
|
||||||
len(r.Inputs),
|
len(r.Inputs),
|
||||||
|
|||||||
@@ -12,22 +12,21 @@ import (
|
|||||||
"testing"
|
"testing"
|
||||||
"testing/fstest"
|
"testing/fstest"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/ConfigKit"
|
"go.maximumdirect.net/configkit"
|
||||||
"gitea.maximumdirect.net/eric/promptkit"
|
"go.maximumdirect.net/promptkit"
|
||||||
)
|
)
|
||||||
|
|
||||||
const capturedPromptDocument = `
|
const capturedPromptDocument = `
|
||||||
prompts:
|
prompts:
|
||||||
captured:
|
- id: captured
|
||||||
"1":
|
default_profile: offline
|
||||||
default_profile: offline
|
session_id: '{{.session}}'
|
||||||
session_id: '{{.session}}'
|
messages:
|
||||||
messages:
|
- role: user
|
||||||
- role: user
|
content_file: body.tmpl
|
||||||
content_file: body.tmpl
|
output:
|
||||||
output:
|
format: text
|
||||||
format: text
|
validation_mode: none
|
||||||
validation_mode: none
|
|
||||||
`
|
`
|
||||||
|
|
||||||
func capturedPromptEngine(t *testing.T, source fs.FS) *promptkit.Engine {
|
func capturedPromptEngine(t *testing.T, source fs.FS) *promptkit.Engine {
|
||||||
@@ -40,8 +39,8 @@ func capturedPromptEngine(t *testing.T, source fs.FS) *promptkit.Engine {
|
|||||||
engine, err := promptkit.NewEngine(promptkit.Config{Sources: promptkit.ConfigurationSources{
|
engine, err := promptkit.NewEngine(promptkit.Config{Sources: promptkit.ConfigurationSources{
|
||||||
Underlays: []configkit.Underlay{
|
Underlays: []configkit.Underlay{
|
||||||
{Inputs: inputs},
|
{Inputs: inputs},
|
||||||
{Inputs: []configkit.Input{{Source: promptkit.ProfileSource("offline profile", map[string]promptkit.ProfileConfig{
|
{Inputs: []configkit.Input{{Source: promptkit.ProfileSource("offline profile", []promptkit.ProfileConfig{
|
||||||
"offline": {Endpoint: &endpoint, Model: &model},
|
{ID: "offline", Endpoint: &endpoint, Model: &model},
|
||||||
})}}},
|
})}}},
|
||||||
},
|
},
|
||||||
}})
|
}})
|
||||||
@@ -145,16 +144,16 @@ func TestPreparationStillReadsRequestArtifactsAndSchemasAfterConstruction(t *tes
|
|||||||
endpoint, model := "https://example.invalid/v1", "offline-model"
|
endpoint, model := "https://example.invalid/v1", "offline-model"
|
||||||
schemas := fstest.MapFS{}
|
schemas := fstest.MapFS{}
|
||||||
engine, err := promptkit.NewEngine(promptkit.Config{Sources: promptkit.ConfigurationSources{
|
engine, err := promptkit.NewEngine(promptkit.Config{Sources: promptkit.ConfigurationSources{
|
||||||
Underlays: []configkit.Underlay{{Inputs: []configkit.Input{{Source: promptkit.ProfileSource("profile", map[string]promptkit.ProfileConfig{
|
Underlays: []configkit.Underlay{{Inputs: []configkit.Input{{Source: promptkit.ProfileSource("profile", []promptkit.ProfileConfig{
|
||||||
"offline": {Endpoint: &endpoint, Model: &model},
|
{ID: "offline", Endpoint: &endpoint, Model: &model},
|
||||||
})}}}},
|
})}}}},
|
||||||
Main: &configkit.Input{Source: configkit.Mapping("structured prompt", map[string]any{
|
Main: &configkit.Input{Source: configkit.Mapping("structured prompt", map[string]any{
|
||||||
"prompts": map[string]any{"structured": map[string]any{"1": map[string]any{
|
"prompts": []any{map[string]any{"id": "structured",
|
||||||
"default_profile": "offline",
|
"default_profile": "offline",
|
||||||
"inputs": []any{map[string]any{"name": "note", "required": true}},
|
"inputs": []any{map[string]any{"name": "note", "required": true}},
|
||||||
"messages": []any{map[string]any{"role": "user", "content": `{{input "note"}}`}},
|
"messages": []any{map[string]any{"role": "user", "content": `{{input "note"}}`}},
|
||||||
"output": map[string]any{"format": "json", "validation_mode": "json_schema", "schema_path": "schema.json"},
|
"output": map[string]any{"format": "json", "validation_mode": "json_schema", "schema_path": "schema.json"},
|
||||||
}}},
|
}},
|
||||||
})},
|
})},
|
||||||
}}, promptkit.WithSchemaFS(schemas, "."))
|
}}, promptkit.WithSchemaFS(schemas, "."))
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
|||||||
@@ -9,7 +9,7 @@ import (
|
|||||||
"strings"
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/promptkit"
|
"go.maximumdirect.net/promptkit"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestBuiltInGenerationError(t *testing.T) {
|
func TestBuiltInGenerationError(t *testing.T) {
|
||||||
|
|||||||
12
go.mod
12
go.mod
@@ -1,20 +1,18 @@
|
|||||||
module gitea.maximumdirect.net/eric/promptkit
|
module go.maximumdirect.net/promptkit
|
||||||
|
|
||||||
go 1.26.0
|
go 1.27.0
|
||||||
|
|
||||||
require (
|
require (
|
||||||
gitea.maximumdirect.net/eric/ConfigKit v0.6.0
|
|
||||||
gitea.maximumdirect.net/eric/promptkit-backend-openrouter/v3 v3.20260930.0
|
|
||||||
gitea.maximumdirect.net/eric/promptkit-backend-rakestrawhome/v3 v3.20260930.0
|
|
||||||
github.com/santhosh-tekuri/jsonschema/v6 v6.0.2
|
github.com/santhosh-tekuri/jsonschema/v6 v6.0.2
|
||||||
|
go.maximumdirect.net/configkit v1.0.0
|
||||||
)
|
)
|
||||||
|
|
||||||
require (
|
require (
|
||||||
gitea.maximumdirect.net/eric/ReleaseKit v0.3.0 // indirect
|
|
||||||
github.com/yuin/goldmark/v2 v2.1.6 // indirect
|
github.com/yuin/goldmark/v2 v2.1.6 // indirect
|
||||||
|
go.maximumdirect.net/releasekit v0.8.0 // indirect
|
||||||
go.yaml.in/yaml/v4 v4.0.0-rc.6 // indirect
|
go.yaml.in/yaml/v4 v4.0.0-rc.6 // indirect
|
||||||
golang.org/x/mod v0.40.0 // indirect
|
golang.org/x/mod v0.40.0 // indirect
|
||||||
golang.org/x/text v0.14.0 // indirect
|
golang.org/x/text v0.14.0 // indirect
|
||||||
)
|
)
|
||||||
|
|
||||||
tool gitea.maximumdirect.net/eric/ReleaseKit/cmd/releasekit
|
tool go.maximumdirect.net/releasekit/cmd/releasekit
|
||||||
|
|||||||
14
go.sum
14
go.sum
@@ -1,22 +1,16 @@
|
|||||||
gitea.maximumdirect.net/eric/ConfigKit v0.6.0 h1:KdsCVO5kKctdAUQJ6X7dJ/GemlVjCYCcn/xZrMAE/aw=
|
|
||||||
gitea.maximumdirect.net/eric/ConfigKit v0.6.0/go.mod h1:xN4dRdDGIW4yh/e9GghDF/hSIzc8/77blRhwyf90KSA=
|
|
||||||
gitea.maximumdirect.net/eric/ReleaseKit v0.3.0 h1:aTMn+50MEpHpHI2RoCCmJYsy7Ohrpa+RSva63Kq0/tU=
|
|
||||||
gitea.maximumdirect.net/eric/ReleaseKit v0.3.0/go.mod h1:LVodqNQ3OIKv9NBq+fFeyMByd1lHY25YOmmpah/NaNI=
|
|
||||||
gitea.maximumdirect.net/eric/promptkit-backend-openrouter/v3 v3.20260930.0 h1:lzfCDbzJQRGzIlRPRprnAV9hVVL5zUQy80VMQ0kbYa0=
|
|
||||||
gitea.maximumdirect.net/eric/promptkit-backend-openrouter/v3 v3.20260930.0/go.mod h1:HjS0f+3q0IdHCTEz+VVAEgIwIWJFAZUjuKdAtvtqKdg=
|
|
||||||
gitea.maximumdirect.net/eric/promptkit-backend-rakestrawhome/v3 v3.20260930.0 h1:h12ZTRldAmpLAomj0oQRGteFxHLN1LPE6XDl9zJNbm8=
|
|
||||||
gitea.maximumdirect.net/eric/promptkit-backend-rakestrawhome/v3 v3.20260930.0/go.mod h1:OEFBeKdjTsLzqJwLmXI2O5gG3r64FktcVJVb3mBrRfg=
|
|
||||||
github.com/dlclark/regexp2 v1.11.0 h1:G/nrcoOa7ZXlpoa/91N3X7mM3r8eIlMBBJZvsz/mxKI=
|
github.com/dlclark/regexp2 v1.11.0 h1:G/nrcoOa7ZXlpoa/91N3X7mM3r8eIlMBBJZvsz/mxKI=
|
||||||
github.com/dlclark/regexp2 v1.11.0/go.mod h1:DHkYz0B9wPfa6wondMfaivmHpzrQ3v9q8cnmRbL6yW8=
|
github.com/dlclark/regexp2 v1.11.0/go.mod h1:DHkYz0B9wPfa6wondMfaivmHpzrQ3v9q8cnmRbL6yW8=
|
||||||
github.com/santhosh-tekuri/jsonschema/v6 v6.0.2 h1:KRzFb2m7YtdldCEkzs6KqmJw4nqEVZGK7IN2kJkjTuQ=
|
github.com/santhosh-tekuri/jsonschema/v6 v6.0.2 h1:KRzFb2m7YtdldCEkzs6KqmJw4nqEVZGK7IN2kJkjTuQ=
|
||||||
github.com/santhosh-tekuri/jsonschema/v6 v6.0.2/go.mod h1:JXeL+ps8p7/KNMjDQk3TCwPpBy0wYklyWTfbkIzdIFU=
|
github.com/santhosh-tekuri/jsonschema/v6 v6.0.2/go.mod h1:JXeL+ps8p7/KNMjDQk3TCwPpBy0wYklyWTfbkIzdIFU=
|
||||||
github.com/yuin/goldmark/v2 v2.1.6 h1:igy0q9JcqovoFXFx/XjtU8sHVhcUHavPj2sA3EoKJUE=
|
github.com/yuin/goldmark/v2 v2.1.6 h1:igy0q9JcqovoFXFx/XjtU8sHVhcUHavPj2sA3EoKJUE=
|
||||||
github.com/yuin/goldmark/v2 v2.1.6/go.mod h1:G6M4/qOFtfn01/o14BU1UR2Lo5N3S9Qo7xCuz/sHjGQ=
|
github.com/yuin/goldmark/v2 v2.1.6/go.mod h1:G6M4/qOFtfn01/o14BU1UR2Lo5N3S9Qo7xCuz/sHjGQ=
|
||||||
|
go.maximumdirect.net/configkit v1.0.0 h1:cguQnxkaRk3ClQOZNzzhTdc4bfzbraGKv8CkoCp+HLc=
|
||||||
|
go.maximumdirect.net/configkit v1.0.0/go.mod h1:B6fJ5xBLBF1nuywqfLeEI4sLm29UkIcDLu8i6I6gGXE=
|
||||||
|
go.maximumdirect.net/releasekit v0.8.0 h1:hSaHPbUI7tAhnolfbu7UMj2fvmm9FGBY+jhkygdbxR0=
|
||||||
|
go.maximumdirect.net/releasekit v0.8.0/go.mod h1:QE4BLrAhVJTzi+/YTcVl21K/qZp9ojRLg5kuoy3Zb44=
|
||||||
go.yaml.in/yaml/v4 v4.0.0-rc.6 h1:1h7H1ohdUh93/FyE4YaDa1Zh64K6VVbjF4K6WUxMtH4=
|
go.yaml.in/yaml/v4 v4.0.0-rc.6 h1:1h7H1ohdUh93/FyE4YaDa1Zh64K6VVbjF4K6WUxMtH4=
|
||||||
go.yaml.in/yaml/v4 v4.0.0-rc.6/go.mod h1:aZqd9kCMsGL7AuUv/m/PvWLdg5sjJsZ4oHDEnfPPfY0=
|
go.yaml.in/yaml/v4 v4.0.0-rc.6/go.mod h1:aZqd9kCMsGL7AuUv/m/PvWLdg5sjJsZ4oHDEnfPPfY0=
|
||||||
golang.org/x/mod v0.40.0 h1:hUv+3cXcdRHz08UmSiOob7sadHig73uo5bkXxQ/tvUs=
|
golang.org/x/mod v0.40.0 h1:hUv+3cXcdRHz08UmSiOob7sadHig73uo5bkXxQ/tvUs=
|
||||||
golang.org/x/mod v0.40.0/go.mod h1:0/weTWkPWGBikyTWAX3dkjVztMmBA5hM0DH6BElSupE=
|
golang.org/x/mod v0.40.0/go.mod h1:0/weTWkPWGBikyTWAX3dkjVztMmBA5hM0DH6BElSupE=
|
||||||
golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ=
|
golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ=
|
||||||
golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
|
golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
|
||||||
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
|
|
||||||
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
|
||||||
|
|||||||
@@ -10,8 +10,8 @@ import (
|
|||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/defaults"
|
"go.maximumdirect.net/promptkit/internal/defaults"
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/domain"
|
"go.maximumdirect.net/promptkit/internal/domain"
|
||||||
)
|
)
|
||||||
|
|
||||||
var (
|
var (
|
||||||
|
|||||||
@@ -11,7 +11,7 @@ import (
|
|||||||
"runtime"
|
"runtime"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/domain"
|
"go.maximumdirect.net/promptkit/internal/domain"
|
||||||
)
|
)
|
||||||
|
|
||||||
var artifactFileReadBenchmarkSink *domain.Artifact
|
var artifactFileReadBenchmarkSink *domain.Artifact
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ import (
|
|||||||
"testing"
|
"testing"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/domain"
|
"go.maximumdirect.net/promptkit/internal/domain"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestFileReaderRejectsFIFOBeforeOpen(t *testing.T) {
|
func TestFileReaderRejectsFIFOBeforeOpen(t *testing.T) {
|
||||||
|
|||||||
@@ -11,7 +11,7 @@ import (
|
|||||||
"strings"
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/domain"
|
"go.maximumdirect.net/promptkit/internal/domain"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestCompositeReaderRejectsUnsupportedReferences(t *testing.T) {
|
func TestCompositeReaderRejectsUnsupportedReferences(t *testing.T) {
|
||||||
|
|||||||
@@ -6,14 +6,13 @@ import (
|
|||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/domain"
|
"go.maximumdirect.net/promptkit/internal/domain"
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/jsonvalue"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
// OpenRouterID identifies the maintained OpenRouter backend.
|
// OpenRouterID is the conventional OpenRouter backend identifier.
|
||||||
OpenRouterID = "openrouter"
|
OpenRouterID = "openrouter"
|
||||||
// RakestrawHomeID identifies the maintained Rakestrawhome backend.
|
// RakestrawHomeID is the conventional Rakestrawhome backend identifier.
|
||||||
RakestrawHomeID = "rakestrawhome"
|
RakestrawHomeID = "rakestrawhome"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -31,13 +30,12 @@ type Registry struct {
|
|||||||
func NewEffectiveRegistry(definitions map[string]domain.Backend) (*Registry, error) {
|
func NewEffectiveRegistry(definitions map[string]domain.Backend) (*Registry, error) {
|
||||||
registry := &Registry{backends: make(map[string]domain.Backend, len(definitions))}
|
registry := &Registry{backends: make(map[string]domain.Backend, len(definitions))}
|
||||||
for id, definition := range definitions {
|
for id, definition := range definitions {
|
||||||
params, err := jsonvalue.CopyMap(definition.ExtraParams)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("backend %q extra parameters: %w", id, err)
|
|
||||||
}
|
|
||||||
definition.ID = id
|
definition.ID = id
|
||||||
definition.ExtraParams = params
|
cloned, err := domain.CloneBackend(definition)
|
||||||
registry.backends[id] = definition
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("backend %q: %w", id, err)
|
||||||
|
}
|
||||||
|
registry.backends[id] = cloned
|
||||||
}
|
}
|
||||||
return registry, nil
|
return registry, nil
|
||||||
}
|
}
|
||||||
@@ -51,12 +49,11 @@ func (r *Registry) GetBackend(id string) (domain.Backend, error) {
|
|||||||
if !ok {
|
if !ok {
|
||||||
return domain.Backend{}, fmt.Errorf("%w: %q", ErrBackendNotFound, id)
|
return domain.Backend{}, fmt.Errorf("%w: %q", ErrBackendNotFound, id)
|
||||||
}
|
}
|
||||||
extraParams, err := jsonvalue.CopyMap(definition.ExtraParams)
|
cloned, err := domain.CloneBackend(definition)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return domain.Backend{}, fmt.Errorf("copy backend %q: %w", id, err)
|
return domain.Backend{}, fmt.Errorf("copy backend %q: %w", id, err)
|
||||||
}
|
}
|
||||||
definition.ExtraParams = extraParams
|
return cloned, nil
|
||||||
return definition, nil
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// CapacityPolicies returns a copy of the normalized policies for limited
|
// CapacityPolicies returns a copy of the normalized policies for limited
|
||||||
|
|||||||
@@ -5,31 +5,67 @@ import (
|
|||||||
"reflect"
|
"reflect"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/backend"
|
"go.maximumdirect.net/promptkit/internal/backend"
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/domain"
|
"go.maximumdirect.net/promptkit/internal/domain"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestEffectiveRegistryOwnsDefinitionsAndCapacityPolicies(t *testing.T) {
|
func TestEffectiveRegistryOwnsDefinitionsAndCapacityPolicies(t *testing.T) {
|
||||||
params := map[string]any{"nested": map[string]any{"enabled": true}}
|
params := map[string]any{"nested": map[string]any{"enabled": true}}
|
||||||
|
defaultProfile := "catalog-profile"
|
||||||
|
reachabilityEndpoint := "https://probe.example/ready"
|
||||||
|
authenticationKind := "openrouter_key"
|
||||||
|
authenticationEndpoint := "https://probe.example/key"
|
||||||
|
smokeTests := &domain.BackendSmokeTestConfig{
|
||||||
|
DefaultProfile: &defaultProfile,
|
||||||
|
Reachability: &domain.ReachabilityProbeConfig{Endpoint: &reachabilityEndpoint},
|
||||||
|
Authentication: &domain.AuthenticationProbeConfig{
|
||||||
|
Kind: &authenticationKind, Endpoint: &authenticationEndpoint,
|
||||||
|
},
|
||||||
|
}
|
||||||
registry, err := backend.NewEffectiveRegistry(map[string]domain.Backend{
|
registry, err := backend.NewEffectiveRegistry(map[string]domain.Backend{
|
||||||
" local.v1 ": {
|
" local.v1 ": {
|
||||||
Endpoint: "https://backend.example/v1", ExtraParams: params,
|
Endpoint: "https://backend.example/v1", ExtraParams: params,
|
||||||
ConcurrencyLimit: 2, QueueCapacity: 3, QueueCapacitySet: true,
|
ConcurrencyLimit: 2, QueueCapacity: 3, QueueCapacitySet: true,
|
||||||
|
SmokeTests: smokeTests,
|
||||||
},
|
},
|
||||||
})
|
})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
params["nested"].(map[string]any)["enabled"] = false
|
params["nested"].(map[string]any)["enabled"] = false
|
||||||
|
defaultProfile = "mutated-profile"
|
||||||
|
reachabilityEndpoint = "https://mutated.example/ready"
|
||||||
|
authenticationKind = "none"
|
||||||
|
authenticationEndpoint = "https://mutated.example/key"
|
||||||
selected, err := registry.GetBackend(" local.v1 ")
|
selected, err := registry.GetBackend(" local.v1 ")
|
||||||
if err != nil || selected.ID != " local.v1 " || selected.ExtraParams["nested"].(map[string]any)["enabled"] != true {
|
if err != nil || selected.ID != " local.v1 " || selected.ExtraParams["nested"].(map[string]any)["enabled"] != true {
|
||||||
t.Fatalf("effective backend was not captured under its literal ID: %+v, %v", selected, err)
|
t.Fatalf("effective backend was not captured under its literal ID: %+v, %v", selected, err)
|
||||||
}
|
}
|
||||||
|
if selected.SmokeTests == nil || selected.SmokeTests.DefaultProfile == nil ||
|
||||||
|
*selected.SmokeTests.DefaultProfile != "catalog-profile" || selected.SmokeTests.Reachability == nil ||
|
||||||
|
selected.SmokeTests.Reachability.Endpoint == nil || *selected.SmokeTests.Reachability.Endpoint != "https://probe.example/ready" ||
|
||||||
|
selected.SmokeTests.Authentication == nil || selected.SmokeTests.Authentication.Kind == nil ||
|
||||||
|
*selected.SmokeTests.Authentication.Kind != "openrouter_key" || selected.SmokeTests.Authentication.Endpoint == nil ||
|
||||||
|
*selected.SmokeTests.Authentication.Endpoint != "https://probe.example/key" {
|
||||||
|
t.Fatalf("registry did not capture nested diagnostic metadata: %+v", selected.SmokeTests)
|
||||||
|
}
|
||||||
selected.ExtraParams["nested"].(map[string]any)["enabled"] = false
|
selected.ExtraParams["nested"].(map[string]any)["enabled"] = false
|
||||||
|
*selected.SmokeTests.DefaultProfile = "mutated-return"
|
||||||
|
*selected.SmokeTests.Reachability.Endpoint = "https://mutated-return.example/ready"
|
||||||
|
*selected.SmokeTests.Authentication.Kind = "none"
|
||||||
|
*selected.SmokeTests.Authentication.Endpoint = "https://mutated-return.example/key"
|
||||||
again, err := registry.GetBackend(" local.v1 ")
|
again, err := registry.GetBackend(" local.v1 ")
|
||||||
if err != nil || again.ExtraParams["nested"].(map[string]any)["enabled"] != true {
|
if err != nil || again.ExtraParams["nested"].(map[string]any)["enabled"] != true {
|
||||||
t.Fatalf("lookup exposed registry values: %+v, %v", again, err)
|
t.Fatalf("lookup exposed registry values: %+v, %v", again, err)
|
||||||
}
|
}
|
||||||
|
if again.SmokeTests == nil || again.SmokeTests.DefaultProfile == nil ||
|
||||||
|
*again.SmokeTests.DefaultProfile != "catalog-profile" || again.SmokeTests.Reachability == nil ||
|
||||||
|
again.SmokeTests.Reachability.Endpoint == nil || *again.SmokeTests.Reachability.Endpoint != "https://probe.example/ready" ||
|
||||||
|
again.SmokeTests.Authentication == nil || again.SmokeTests.Authentication.Kind == nil ||
|
||||||
|
*again.SmokeTests.Authentication.Kind != "openrouter_key" || again.SmokeTests.Authentication.Endpoint == nil ||
|
||||||
|
*again.SmokeTests.Authentication.Endpoint != "https://probe.example/key" {
|
||||||
|
t.Fatalf("lookup exposed nested diagnostic metadata: %+v", again.SmokeTests)
|
||||||
|
}
|
||||||
policies := registry.CapacityPolicies()
|
policies := registry.CapacityPolicies()
|
||||||
if !reflect.DeepEqual(policies, map[string]domain.BackendCapacityPolicy{
|
if !reflect.DeepEqual(policies, map[string]domain.BackendCapacityPolicy{
|
||||||
" local.v1 ": {ConcurrencyLimit: 2, QueueCapacity: 3},
|
" local.v1 ": {ConcurrencyLimit: 2, QueueCapacity: 3},
|
||||||
|
|||||||
@@ -3,8 +3,8 @@ package capacity
|
|||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/domain"
|
"go.maximumdirect.net/promptkit/internal/domain"
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/llm"
|
"go.maximumdirect.net/promptkit/internal/llm"
|
||||||
)
|
)
|
||||||
|
|
||||||
type client struct {
|
type client struct {
|
||||||
|
|||||||
@@ -10,8 +10,8 @@ import (
|
|||||||
"testing"
|
"testing"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/domain"
|
"go.maximumdirect.net/promptkit/internal/domain"
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/llm"
|
"go.maximumdirect.net/promptkit/internal/llm"
|
||||||
)
|
)
|
||||||
|
|
||||||
type generateResult struct {
|
type generateResult struct {
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ import (
|
|||||||
"strings"
|
"strings"
|
||||||
"sync"
|
"sync"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/domain"
|
"go.maximumdirect.net/promptkit/internal/domain"
|
||||||
)
|
)
|
||||||
|
|
||||||
// ErrCapacityExceeded identifies an admission rejected because a backend's
|
// ErrCapacityExceeded identifies an admission rejected because a backend's
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ import (
|
|||||||
"errors"
|
"errors"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/domain"
|
"go.maximumdirect.net/promptkit/internal/domain"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestNewManagerRejectsInvalidPolicies(t *testing.T) {
|
func TestNewManagerRejectsInvalidPolicies(t *testing.T) {
|
||||||
|
|||||||
@@ -1,52 +0,0 @@
|
|||||||
// Package catalog selects the maintained configuration assets supplied with
|
|
||||||
// PromptKit. ConfigKit owns their composition and effective validation.
|
|
||||||
package catalog
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"fmt"
|
|
||||||
"io/fs"
|
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/ConfigKit"
|
|
||||||
openrouter "gitea.maximumdirect.net/eric/promptkit-backend-openrouter/v3"
|
|
||||||
rakestrawhome "gitea.maximumdirect.net/eric/promptkit-backend-rakestrawhome/v3"
|
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/backend"
|
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/filecatalog"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Underlays selects external catalogs followed by PromptKit-owned profiles.
|
|
||||||
// Neither group is interpreted before the final effective configuration loads.
|
|
||||||
func Underlays() ([]configkit.Underlay, error) {
|
|
||||||
openrouterInputs, err := assetInputs("OpenRouter catalog", openrouter.FS(), openrouter.Root)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
rakestrawhomeInputs, err := assetInputs("Rakestrawhome catalog", rakestrawhome.FS(), rakestrawhome.Root)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
catalogInputs := append(openrouterInputs, rakestrawhomeInputs...)
|
|
||||||
owned := configkit.Input{Source: configkit.Mapping("PromptKit-owned profiles", map[string]any{
|
|
||||||
"profiles": map[string]any{
|
|
||||||
"promptkit-openrouter-standard": map[string]any{"extends": "gemini-flash-latest"},
|
|
||||||
"promptkit-openrouter-auto": map[string]any{"backend": backend.OpenRouterID, "model": "openrouter/auto"},
|
|
||||||
},
|
|
||||||
})}
|
|
||||||
return []configkit.Underlay{{Inputs: catalogInputs}, {Inputs: []configkit.Input{owned}}}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func assetInputs(label string, filesystem fs.FS, root string) ([]configkit.Input, error) {
|
|
||||||
files, err := filecatalog.FindFSYAMLFiles(context.Background(), filesystem, root)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("discover %s configuration: %w", label, err)
|
|
||||||
}
|
|
||||||
namespace := configkit.NewFilesystem(label, filesystem)
|
|
||||||
inputs := make([]configkit.Input, 0, len(files))
|
|
||||||
for _, name := range files {
|
|
||||||
inputs = append(inputs, configkit.Input{
|
|
||||||
Source: namespace.File(name),
|
|
||||||
Filesystem: &configkit.FilesystemContext{FS: &namespace, Root: root},
|
|
||||||
})
|
|
||||||
}
|
|
||||||
return inputs, nil
|
|
||||||
}
|
|
||||||
@@ -1,68 +0,0 @@
|
|||||||
package catalog
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/ConfigKit"
|
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/configuration"
|
|
||||||
)
|
|
||||||
|
|
||||||
func TestPublishedCatalogsResolveThroughEffectiveConfiguration(t *testing.T) {
|
|
||||||
underlays, err := Underlays()
|
|
||||||
if err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
state, err := configuration.Load(configkit.Input{Source: configkit.NoSource()}, underlays)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
openrouter, err := state.GetBackend("openrouter")
|
|
||||||
if err != nil || openrouter.Endpoint != "https://openrouter.ai/api/v1" || openrouter.ConcurrencyLimit != 16 || openrouter.QueueCapacity != 1024 {
|
|
||||||
t.Fatalf("OpenRouter backend: %+v, %v", openrouter, err)
|
|
||||||
}
|
|
||||||
rakestrawhome, err := state.GetBackend("rakestrawhome")
|
|
||||||
if err != nil || rakestrawhome.Endpoint != "https://inference.ai.rakestrawhome.com/v1" || rakestrawhome.ConcurrencyLimit != 4 {
|
|
||||||
t.Fatalf("Rakestrawhome backend: %+v, %v", rakestrawhome, err)
|
|
||||||
}
|
|
||||||
for id, want := range map[string]string{
|
|
||||||
"promptkit-openrouter-standard": "~google/gemini-flash-latest",
|
|
||||||
"promptkit-openrouter-auto": "openrouter/auto",
|
|
||||||
"rakestrawhome-gemma-4-31b": "google/gemma-4-31b-it",
|
|
||||||
} {
|
|
||||||
profile, err := state.GetProfile(context.Background(), id)
|
|
||||||
if err != nil || profile.ResolvedTarget.Model != want {
|
|
||||||
t.Fatalf("profile %s: %+v, %v", id, profile, err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestConsumerOverlayReplacesCatalogDefaultsBeforeValidation(t *testing.T) {
|
|
||||||
underlays, err := Underlays()
|
|
||||||
if err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
underlays = append(underlays, configkit.Underlay{Inputs: []configkit.Input{{Source: configkit.Mapping("operator", map[string]any{
|
|
||||||
"backends": map[string]any{"openrouter": map[string]any{"endpoint": "invalid lower value"}},
|
|
||||||
})}}})
|
|
||||||
main := configkit.Input{Source: configkit.Mapping("application", map[string]any{
|
|
||||||
"backends": map[string]any{"openrouter": map[string]any{"endpoint": "https://alternate.example/v1"}},
|
|
||||||
"profiles": map[string]any{"gemini-flash-latest": map[string]any{"model": "consumer-model"}},
|
|
||||||
})}
|
|
||||||
state, err := configuration.Load(main, underlays)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("replaced lower-layer value failed final validation: %v", err)
|
|
||||||
}
|
|
||||||
profile, err := state.GetProfile(context.Background(), "promptkit-openrouter-standard")
|
|
||||||
if err != nil || profile.ResolvedTarget.Model != "consumer-model" || profile.ResolvedTarget.Endpoint != "https://alternate.example/v1" {
|
|
||||||
t.Fatalf("maintained profile did not observe final configuration: %+v, %v", profile, err)
|
|
||||||
}
|
|
||||||
_, err = configuration.Load(configkit.Input{Source: configkit.Mapping("invalid final", map[string]any{
|
|
||||||
"backends": map[string]any{"openrouter": map[string]any{"endpoint": "invalid final value"}},
|
|
||||||
})}, underlays[:2])
|
|
||||||
var loadError *configkit.LoadError
|
|
||||||
if !errors.As(err, &loadError) {
|
|
||||||
t.Fatalf("invalid final backend did not produce a ConfigKit load error: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -6,8 +6,8 @@ import (
|
|||||||
"testing"
|
"testing"
|
||||||
"testing/fstest"
|
"testing/fstest"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/ConfigKit"
|
"go.maximumdirect.net/configkit"
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/domain"
|
"go.maximumdirect.net/promptkit/internal/domain"
|
||||||
)
|
)
|
||||||
|
|
||||||
const benchmarkDefinitionCount = 128
|
const benchmarkDefinitionCount = 128
|
||||||
@@ -37,6 +37,20 @@ func benchmarkPrompt(profileID string) map[string]any {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func benchmarkRecords(values map[string]any) []any {
|
||||||
|
records := make([]any, 0, len(values))
|
||||||
|
for _, id := range sortedKeys(values) {
|
||||||
|
value := values[id].(map[string]any)
|
||||||
|
record := make(map[string]any, len(value)+1)
|
||||||
|
for key, field := range value {
|
||||||
|
record[key] = field
|
||||||
|
}
|
||||||
|
record["id"] = id
|
||||||
|
records = append(records, record)
|
||||||
|
}
|
||||||
|
return records
|
||||||
|
}
|
||||||
|
|
||||||
func independentDefinitions(count int) configurationShape {
|
func independentDefinitions(count int) configurationShape {
|
||||||
profiles := make(map[string]any, count)
|
profiles := make(map[string]any, count)
|
||||||
prompts := make(map[string]any, count)
|
prompts := make(map[string]any, count)
|
||||||
@@ -44,10 +58,10 @@ func independentDefinitions(count int) configurationShape {
|
|||||||
profileID := fmt.Sprintf("profile-%03d", index)
|
profileID := fmt.Sprintf("profile-%03d", index)
|
||||||
promptID := fmt.Sprintf("prompt-%03d", index)
|
promptID := fmt.Sprintf("prompt-%03d", index)
|
||||||
profiles[profileID] = map[string]any{"endpoint": "https://example.test/v1", "model": profileID}
|
profiles[profileID] = map[string]any{"endpoint": "https://example.test/v1", "model": profileID}
|
||||||
prompts[promptID] = map[string]any{"1": benchmarkPrompt(profileID)}
|
prompts[promptID] = benchmarkPrompt(profileID)
|
||||||
}
|
}
|
||||||
return configurationShape{
|
return configurationShape{
|
||||||
main: configkit.Input{Source: configkit.Mapping("independent definitions", map[string]any{"profiles": profiles, "prompts": prompts})},
|
main: configkit.Input{Source: configkit.Mapping("independent definitions", map[string]any{"profiles": benchmarkRecords(profiles), "prompts": benchmarkRecords(prompts)})},
|
||||||
inputEntries: count * 2,
|
inputEntries: count * 2,
|
||||||
effectiveEntries: count * 2,
|
effectiveEntries: count * 2,
|
||||||
tiers: 1,
|
tiers: 1,
|
||||||
@@ -63,14 +77,14 @@ func fileBackedDefinitions(count int) configurationShape {
|
|||||||
profiles[profileID] = map[string]any{"endpoint": "https://example.test/v1", "model": profileID}
|
profiles[profileID] = map[string]any{"endpoint": "https://example.test/v1", "model": profileID}
|
||||||
prompt := benchmarkPrompt(profileID)
|
prompt := benchmarkPrompt(profileID)
|
||||||
prompt["messages"] = []any{map[string]any{"role": "user", "content_file": "body.md"}}
|
prompt["messages"] = []any{map[string]any{"role": "user", "content_file": "body.md"}}
|
||||||
prompts[promptID] = map[string]any{"1": prompt}
|
prompts[promptID] = prompt
|
||||||
}
|
}
|
||||||
namespace := configkit.NewFilesystem("benchmark content", fstest.MapFS{
|
namespace := configkit.NewFilesystem("benchmark content", fstest.MapFS{
|
||||||
"assets/body.md": &fstest.MapFile{Data: []byte("Hello {{.name}}")},
|
"assets/body.md": &fstest.MapFile{Data: []byte("Hello {{.name}}")},
|
||||||
})
|
})
|
||||||
return configurationShape{
|
return configurationShape{
|
||||||
main: configkit.Input{
|
main: configkit.Input{
|
||||||
Source: configkit.Mapping("file-backed definitions", map[string]any{"profiles": profiles, "prompts": prompts}),
|
Source: configkit.Mapping("file-backed definitions", map[string]any{"profiles": benchmarkRecords(profiles), "prompts": benchmarkRecords(prompts)}),
|
||||||
Filesystem: &configkit.FilesystemContext{FS: &namespace, Root: ".", BaseDir: "assets"},
|
Filesystem: &configkit.FilesystemContext{FS: &namespace, Root: ".", BaseDir: "assets"},
|
||||||
},
|
},
|
||||||
inputEntries: count * 2, effectiveEntries: count * 2, tiers: 1,
|
inputEntries: count * 2, effectiveEntries: count * 2, tiers: 1,
|
||||||
@@ -84,12 +98,12 @@ func sharedBaseDefinitions(count int) configurationShape {
|
|||||||
"extra_params": map[string]any{"provider": map[string]any{"mode": "shared", "limit": 4}},
|
"extra_params": map[string]any{"provider": map[string]any{"mode": "shared", "limit": 4}},
|
||||||
}
|
}
|
||||||
for index := range count {
|
for index := range count {
|
||||||
profiles[fmt.Sprintf("child-%03d", index)] = map[string]any{"extends": "base", "temperature": float64(index%10) / 10}
|
profiles[fmt.Sprintf("child-%03d", index)] = map[string]any{"extends": map[string]any{"id": "base"}, "temperature": float64(index%10) / 10}
|
||||||
}
|
}
|
||||||
return configurationShape{
|
return configurationShape{
|
||||||
main: configkit.Input{Source: configkit.Mapping("inherited definitions", map[string]any{
|
main: configkit.Input{Source: configkit.Mapping("inherited definitions", map[string]any{
|
||||||
"profiles": profiles,
|
"profiles": benchmarkRecords(profiles),
|
||||||
"prompts": map[string]any{"shared": map[string]any{"1": benchmarkPrompt(fmt.Sprintf("child-%03d", count-1))}},
|
"prompts": benchmarkRecords(map[string]any{"shared": benchmarkPrompt(fmt.Sprintf("child-%03d", count-1))}),
|
||||||
})},
|
})},
|
||||||
inputEntries: count + 2,
|
inputEntries: count + 2,
|
||||||
effectiveEntries: count + 2,
|
effectiveEntries: count + 2,
|
||||||
@@ -105,19 +119,19 @@ func layeredDefinitions(count int) configurationShape {
|
|||||||
for index := range count {
|
for index := range count {
|
||||||
id := fmt.Sprintf("profile-%03d", index)
|
id := fmt.Sprintf("profile-%03d", index)
|
||||||
base[id] = map[string]any{"endpoint": "https://example.test/v1", "model": "base-model"}
|
base[id] = map[string]any{"endpoint": "https://example.test/v1", "model": "base-model"}
|
||||||
operator[id] = map[string]any{"model": "operator-model"}
|
operator[id] = map[string]any{"endpoint": "https://example.test/v1", "model": "operator-model"}
|
||||||
programmatic[id] = map[string]any{"extra_params": map[string]any{"provider": map[string]any{"mode": "programmatic"}}}
|
programmatic[id] = map[string]any{"endpoint": "https://example.test/v1", "model": "operator-model", "extra_params": map[string]any{"provider": map[string]any{"mode": "programmatic"}}}
|
||||||
final[id] = map[string]any{"temperature": float64(index%10) / 10}
|
final[id] = map[string]any{"endpoint": "https://example.test/v1", "model": "operator-model", "extra_params": map[string]any{"provider": map[string]any{"mode": "programmatic"}}, "temperature": float64(index%10) / 10}
|
||||||
}
|
}
|
||||||
return configurationShape{
|
return configurationShape{
|
||||||
underlays: []configkit.Underlay{
|
underlays: []configkit.Underlay{
|
||||||
{Inputs: []configkit.Input{{Source: configkit.Mapping("fallback", map[string]any{"profiles": base})}}},
|
{Inputs: []configkit.Input{{Source: configkit.Mapping("fallback", map[string]any{"profiles": benchmarkRecords(base)})}}},
|
||||||
{Inputs: []configkit.Input{{Source: configkit.Mapping("operator", map[string]any{"profiles": operator})}}},
|
{Inputs: []configkit.Input{{Source: configkit.Mapping("operator", map[string]any{"profiles": benchmarkRecords(operator)})}}},
|
||||||
{Inputs: []configkit.Input{{Source: configkit.Mapping("programmatic", map[string]any{"profiles": programmatic})}}},
|
{Inputs: []configkit.Input{{Source: configkit.Mapping("programmatic", map[string]any{"profiles": benchmarkRecords(programmatic)})}}},
|
||||||
},
|
},
|
||||||
main: configkit.Input{Source: configkit.Mapping("main", map[string]any{
|
main: configkit.Input{Source: configkit.Mapping("main", map[string]any{
|
||||||
"profiles": final,
|
"profiles": benchmarkRecords(final),
|
||||||
"prompts": map[string]any{"layered": map[string]any{"1": benchmarkPrompt(fmt.Sprintf("profile-%03d", count-1))}},
|
"prompts": benchmarkRecords(map[string]any{"layered": benchmarkPrompt(fmt.Sprintf("profile-%03d", count-1))}),
|
||||||
})},
|
})},
|
||||||
inputEntries: count*4 + 1,
|
inputEntries: count*4 + 1,
|
||||||
effectiveEntries: count + 1,
|
effectiveEntries: count + 1,
|
||||||
@@ -125,6 +139,40 @@ func layeredDefinitions(count int) configurationShape {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func BenchmarkCollectionFileBackedConstruction(b *testing.B) {
|
||||||
|
for _, count := range []int{4, 16, 64} {
|
||||||
|
b.Run(fmt.Sprintf("collections_%d", count), func(b *testing.B) {
|
||||||
|
collections := make(map[string]any, count)
|
||||||
|
for index := range count {
|
||||||
|
collections[fmt.Sprintf("collection-%03d", index)] = map[string]any{
|
||||||
|
"prompts": []any{
|
||||||
|
map[string]any{"id": "example",
|
||||||
|
"messages": []any{map[string]any{"role": "user", "content_file": "body.md"}},
|
||||||
|
"output": map[string]any{"format": "text", "validation_mode": "none"},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
namespace := configkit.NewFilesystem("collection benchmark", fstest.MapFS{
|
||||||
|
"body.md": {Data: []byte("Hello")},
|
||||||
|
})
|
||||||
|
main := configkit.Input{
|
||||||
|
Source: configkit.Mapping("collections", map[string]any{"collections": collections}),
|
||||||
|
Filesystem: &configkit.FilesystemContext{FS: &namespace, Root: ".", BaseDir: "."},
|
||||||
|
}
|
||||||
|
b.ReportAllocs()
|
||||||
|
for b.Loop() {
|
||||||
|
result, err := load(main, nil)
|
||||||
|
if err != nil {
|
||||||
|
b.Fatal(err)
|
||||||
|
}
|
||||||
|
constructionResult = result
|
||||||
|
}
|
||||||
|
b.ReportMetric(float64(count), "collections/op")
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func BenchmarkConfigurationConstruction(b *testing.B) {
|
func BenchmarkConfigurationConstruction(b *testing.B) {
|
||||||
for _, scenario := range []struct {
|
for _, scenario := range []struct {
|
||||||
name string
|
name string
|
||||||
@@ -160,7 +208,7 @@ func BenchmarkConfigurationSelection(b *testing.B) {
|
|||||||
b.Run("prompt", func(b *testing.B) {
|
b.Run("prompt", func(b *testing.B) {
|
||||||
b.ReportAllocs()
|
b.ReportAllocs()
|
||||||
for b.Loop() {
|
for b.Loop() {
|
||||||
definition, _, err := result.prompt("prompt-127", "1")
|
definition, _, err := result.prompt("prompt-127")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
b.Fatal(err)
|
b.Fatal(err)
|
||||||
}
|
}
|
||||||
@@ -201,12 +249,12 @@ func inspectionDefinitions(extraParams map[string]any) configurationShape {
|
|||||||
prompt := benchmarkPrompt("small")
|
prompt := benchmarkPrompt("small")
|
||||||
prompt["inputs"] = []any{map[string]any{"name": "transcript", "required": true}}
|
prompt["inputs"] = []any{map[string]any{"name": "transcript", "required": true}}
|
||||||
prompts := map[string]any{
|
prompts := map[string]any{
|
||||||
"inspection": map[string]any{"1": prompt},
|
"inspection": prompt,
|
||||||
}
|
}
|
||||||
return configurationShape{
|
return configurationShape{
|
||||||
main: configkit.Input{Source: configkit.Mapping("inspection definitions", map[string]any{
|
main: configkit.Input{Source: configkit.Mapping("inspection definitions", map[string]any{
|
||||||
"profiles": profiles,
|
"profiles": benchmarkRecords(profiles),
|
||||||
"prompts": prompts,
|
"prompts": benchmarkRecords(prompts),
|
||||||
})},
|
})},
|
||||||
inputEntries: 2, effectiveEntries: 2, tiers: 1,
|
inputEntries: 2, effectiveEntries: 2, tiers: 1,
|
||||||
}
|
}
|
||||||
@@ -226,8 +274,8 @@ func BenchmarkInspectionSelection(b *testing.B) {
|
|||||||
b.Fatal(err)
|
b.Fatal(err)
|
||||||
}
|
}
|
||||||
ctx := context.Background()
|
ctx := context.Background()
|
||||||
definition, hash, err := result.GetPromptSnapshot(ctx, "inspection", "1")
|
definition, hash, err := result.GetPromptSnapshot(ctx, "inspection")
|
||||||
if err != nil || definition.ID != "inspection" || definition.Version != "1" || hash == "" ||
|
if err != nil || definition.ID != "inspection" || hash == "" ||
|
||||||
len(definition.Inputs) != 1 || definition.Inputs[0].Name != "transcript" || !definition.Inputs[0].Required {
|
len(definition.Inputs) != 1 || definition.Inputs[0].Name != "transcript" || !definition.Inputs[0].Required {
|
||||||
b.Fatalf("prompt lookup fixture is invalid: definition=%+v hash=%q err=%v", definition, hash, err)
|
b.Fatalf("prompt lookup fixture is invalid: definition=%+v hash=%q err=%v", definition, hash, err)
|
||||||
}
|
}
|
||||||
@@ -236,8 +284,8 @@ func BenchmarkInspectionSelection(b *testing.B) {
|
|||||||
len(profile.ResolvedTarget.ExtraParams["provider_options"].(map[string]any)) != scenario.entries {
|
len(profile.ResolvedTarget.ExtraParams["provider_options"].(map[string]any)) != scenario.entries {
|
||||||
b.Fatalf("profile lookup fixture is invalid: profile=%+v err=%v", profile, err)
|
b.Fatalf("profile lookup fixture is invalid: profile=%+v err=%v", profile, err)
|
||||||
}
|
}
|
||||||
inspection, err := result.GetPromptInspection(ctx, "inspection", "1")
|
inspection, err := result.GetPromptInspection(ctx, "inspection")
|
||||||
if err != nil || inspection.PromptID != "inspection" || inspection.PromptVersion != "1" ||
|
if err != nil || inspection.PromptID != "inspection" ||
|
||||||
len(inspection.Inputs) != 1 || inspection.Inputs[0].Name != "transcript" {
|
len(inspection.Inputs) != 1 || inspection.Inputs[0].Name != "transcript" {
|
||||||
b.Fatalf("prompt inspection fixture is invalid: inspection=%+v err=%v", inspection, err)
|
b.Fatalf("prompt inspection fixture is invalid: inspection=%+v err=%v", inspection, err)
|
||||||
}
|
}
|
||||||
@@ -249,7 +297,7 @@ func BenchmarkInspectionSelection(b *testing.B) {
|
|||||||
b.Run("prompt/"+scenario.name, func(b *testing.B) {
|
b.Run("prompt/"+scenario.name, func(b *testing.B) {
|
||||||
b.ReportAllocs()
|
b.ReportAllocs()
|
||||||
for b.Loop() {
|
for b.Loop() {
|
||||||
definition, hash, err := result.GetPromptSnapshot(ctx, "inspection", "1")
|
definition, hash, err := result.GetPromptSnapshot(ctx, "inspection")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
b.Fatal(err)
|
b.Fatal(err)
|
||||||
}
|
}
|
||||||
@@ -261,7 +309,7 @@ func BenchmarkInspectionSelection(b *testing.B) {
|
|||||||
b.Run("prompt_inspection/"+scenario.name, func(b *testing.B) {
|
b.Run("prompt_inspection/"+scenario.name, func(b *testing.B) {
|
||||||
b.ReportAllocs()
|
b.ReportAllocs()
|
||||||
for b.Loop() {
|
for b.Loop() {
|
||||||
inspection, err := result.GetPromptInspection(ctx, "inspection", "1")
|
inspection, err := result.GetPromptInspection(ctx, "inspection")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
b.Fatal(err)
|
b.Fatal(err)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,9 +2,10 @@ package configuration
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"io"
|
"io"
|
||||||
|
"strconv"
|
||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/ConfigKit"
|
"go.maximumdirect.net/configkit"
|
||||||
)
|
)
|
||||||
|
|
||||||
// Inspection is the read-only subset of the retained ConfigKit result used by
|
// Inspection is the read-only subset of the retained ConfigKit result used by
|
||||||
@@ -16,6 +17,15 @@ type Inspection interface {
|
|||||||
Explain(configkit.Path) (configkit.Explanation, bool)
|
Explain(configkit.Path) (configkit.Explanation, bool)
|
||||||
WriteEffective(io.Writer) error
|
WriteEffective(io.Writer) error
|
||||||
WriteExplanation(io.Writer, configkit.Path) error
|
WriteExplanation(io.Writer, configkit.Path) error
|
||||||
|
capturedResult() *configkit.Result[document]
|
||||||
|
}
|
||||||
|
|
||||||
|
type inspectionResult struct {
|
||||||
|
*configkit.Result[document]
|
||||||
|
}
|
||||||
|
|
||||||
|
func (inspection inspectionResult) capturedResult() *configkit.Result[document] {
|
||||||
|
return inspection.Result
|
||||||
}
|
}
|
||||||
|
|
||||||
// Inspection returns only the retained result's inspection operations.
|
// Inspection returns only the retained result's inspection operations.
|
||||||
@@ -23,7 +33,19 @@ func (state *loaded) Inspection() Inspection {
|
|||||||
if state == nil {
|
if state == nil {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
return state.result
|
return inspectionResult{Result: state.result}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Diff compares two captured ConfigKit results without reconstructing them.
|
||||||
|
func Diff(left, right Inspection) ([]configkit.Difference, error) {
|
||||||
|
var leftResult, rightResult *configkit.Result[document]
|
||||||
|
if left != nil {
|
||||||
|
leftResult = left.capturedResult()
|
||||||
|
}
|
||||||
|
if right != nil {
|
||||||
|
rightResult = right.capturedResult()
|
||||||
|
}
|
||||||
|
return configkit.Diff(leftResult, rightResult)
|
||||||
}
|
}
|
||||||
|
|
||||||
func secretProviderPath(path configkit.Path) bool {
|
func secretProviderPath(path configkit.Path) bool {
|
||||||
@@ -32,7 +54,7 @@ func secretProviderPath(path configkit.Path) bool {
|
|||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
parts := strings.Split(strings.TrimPrefix(pointer, "/"), "/")
|
parts := strings.Split(strings.TrimPrefix(pointer, "/"), "/")
|
||||||
if len(parts) < 4 || (parts[0] != "backends" && parts[0] != "profiles") || parts[2] != "extra_params" {
|
if !providerExtraParamsPath(parts) {
|
||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
key := strings.ToLower(strings.ReplaceAll(strings.ReplaceAll(parts[len(parts)-1], "~1", "/"), "~0", "~"))
|
key := strings.ToLower(strings.ReplaceAll(strings.ReplaceAll(parts[len(parts)-1], "~1", "/"), "~0", "~"))
|
||||||
@@ -43,3 +65,18 @@ func secretProviderPath(path configkit.Path) bool {
|
|||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func providerExtraParamsPath(parts []string) bool {
|
||||||
|
if len(parts) >= 4 && sequenceIndex(parts[1]) &&
|
||||||
|
(parts[0] == "backends" || parts[0] == "profiles") && parts[2] == "extra_params" {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
return len(parts) >= 6 && parts[0] == "collections" && parts[1] != "" &&
|
||||||
|
(parts[2] == "backends" || parts[2] == "profiles") &&
|
||||||
|
sequenceIndex(parts[3]) && parts[4] == "extra_params"
|
||||||
|
}
|
||||||
|
|
||||||
|
func sequenceIndex(segment string) bool {
|
||||||
|
index, err := strconv.Atoi(segment)
|
||||||
|
return err == nil && index >= 0 && strconv.Itoa(index) == segment
|
||||||
|
}
|
||||||
|
|||||||
32
internal/configuration/inspection_test.go
Normal file
32
internal/configuration/inspection_test.go
Normal file
@@ -0,0 +1,32 @@
|
|||||||
|
package configuration
|
||||||
|
|
||||||
|
import (
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"go.maximumdirect.net/configkit"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestSecretProviderPathRecognizesResourceExtraParams(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
path configkit.Path
|
||||||
|
want bool
|
||||||
|
}{
|
||||||
|
{name: "backend nested secret", path: configkit.Keys("backends").Index(0).Key("extra_params").Key("nested").Key("Token"), want: true},
|
||||||
|
{name: "profile nested secret", path: configkit.Keys("profiles").Index(1).Key("extra_params").Key("authorization"), want: true},
|
||||||
|
{name: "collection backend nested secret", path: configkit.Keys("collections", "provider", "backends").Index(2).Key("extra_params").Key("nested").Key("Token"), want: true},
|
||||||
|
{name: "collection profile secret", path: configkit.Keys("collections", "assistant", "profiles").Index(0).Key("extra_params").Key("authorization"), want: true},
|
||||||
|
{name: "unrelated nested mapping", path: configkit.Keys("application", "backends", "provider", "extra_params", "token"), want: false},
|
||||||
|
{name: "extra params outside resource map", path: configkit.Keys("backends", "provider", "options", "extra_params", "token"), want: false},
|
||||||
|
{name: "collection extra params outside resource map", path: configkit.Keys("collections", "provider", "settings", "backends", "default", "extra_params", "token"), want: false},
|
||||||
|
{name: "missing resource key", path: configkit.Keys("backends", "", "extra_params", "token"), want: false},
|
||||||
|
{name: "ordinary provider value", path: configkit.Keys("profiles").Index(0).Key("extra_params").Key("provider").Key("mode"), want: false},
|
||||||
|
}
|
||||||
|
for _, test := range tests {
|
||||||
|
t.Run(test.name, func(t *testing.T) {
|
||||||
|
if got := secretProviderPath(test.path); got != test.want {
|
||||||
|
t.Fatalf("secretProviderPath(%q) = %t, want %t", test.path, got, test.want)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
72
internal/configuration/interpretation_test.go
Normal file
72
internal/configuration/interpretation_test.go
Normal file
@@ -0,0 +1,72 @@
|
|||||||
|
package configuration
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"go.maximumdirect.net/configkit"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestTargetInterpretationPreservesComposedNestedValues(t *testing.T) {
|
||||||
|
state, err := load(mapping("padded target", map[string]any{
|
||||||
|
"backends": []any{map[string]any{
|
||||||
|
"id": "local", "endpoint": " HTTPS://example.invalid/v1 ", "concurrency_limit": 1,
|
||||||
|
"smoke_tests": map[string]any{
|
||||||
|
"reachability": map[string]any{"endpoint": " https://example.invalid/health "},
|
||||||
|
"authentication": map[string]any{"kind": " NONE ", "endpoint": " https://example.invalid/key "},
|
||||||
|
},
|
||||||
|
}},
|
||||||
|
"profiles": []any{map[string]any{"id": "partial", "backend": "local", "service_tier": " standard ", "api_key_env": " TOKEN "}},
|
||||||
|
}), nil)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
backend, err := state.GetBackend("local")
|
||||||
|
if err != nil || backend.Endpoint != "https://example.invalid/v1" || backend.QueueCapacity != 1024 ||
|
||||||
|
backend.SmokeTests == nil || *backend.SmokeTests.Reachability.Endpoint != "https://example.invalid/health" ||
|
||||||
|
*backend.SmokeTests.Authentication.Kind != "none" || *backend.SmokeTests.Authentication.Endpoint != "https://example.invalid/key" {
|
||||||
|
t.Fatalf("interpreted backend = %+v, %v", backend, err)
|
||||||
|
}
|
||||||
|
profile, err := state.GetProfile(context.Background(), "partial")
|
||||||
|
if err != nil || profile.ResolvedTarget.ServiceTier != "standard" || profile.ResolvedTarget.APIKeyEnv != "TOKEN" {
|
||||||
|
t.Fatalf("interpreted profile = %+v, %v", profile, err)
|
||||||
|
}
|
||||||
|
composed := state.result.Config.Backends[0]
|
||||||
|
if *composed.Endpoint != " HTTPS://example.invalid/v1 " || composed.QueueCapacity != nil ||
|
||||||
|
*composed.SmokeTests.Reachability.Endpoint != " https://example.invalid/health " ||
|
||||||
|
*composed.SmokeTests.Authentication.Kind != " NONE " || *composed.SmokeTests.Authentication.Endpoint != " https://example.invalid/key " ||
|
||||||
|
*state.result.Config.Profiles[0].ServiceTier != " standard " || *state.result.Config.Profiles[0].APIKeyEnv != " TOKEN " {
|
||||||
|
t.Fatalf("composed values were mutated: %+v", state.result.Config)
|
||||||
|
}
|
||||||
|
path := configkit.Keys("backends").Index(0).Key("smoke_tests").Key("authentication").Key("endpoint")
|
||||||
|
field, found := state.result.Metadata().Lookup(path)
|
||||||
|
if !found || len(field.Origin.Locations) == 0 || field.Origin.Operation == configkit.ChangeNormalization {
|
||||||
|
t.Fatalf("nested field origin changed: %+v", field)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestPromptInterpretationPreservesComposedOutputAndRejectsDuplicateNames(t *testing.T) {
|
||||||
|
definition := map[string]any{
|
||||||
|
"id": "example", "inputs": []any{map[string]any{"name": " document "}},
|
||||||
|
"messages": []any{map[string]any{"role": "user", "content": "hello"}},
|
||||||
|
"output": map[string]any{"format": "json", "validation_mode": "json_schema", "schema_path": " schema.json "},
|
||||||
|
}
|
||||||
|
state, err := load(mapping("prompt metadata", map[string]any{"prompts": []any{definition}}), nil)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
selected, inspection, err := state.prompt("example")
|
||||||
|
if err != nil || selected.Validation.SchemaPath != "schema.json" || inspection.OutputContract.SchemaPath != "schema.json" || selected.Inputs[0].Name != "document" {
|
||||||
|
t.Fatalf("interpreted prompt = %+v, %+v, %v", selected, inspection, err)
|
||||||
|
}
|
||||||
|
composed := state.result.Config.Prompts[0]
|
||||||
|
if *composed.Output.SchemaPath != " schema.json " || composed.Inputs[0].Name != " document " {
|
||||||
|
t.Fatalf("composed prompt changed: %+v", composed)
|
||||||
|
}
|
||||||
|
definition["inputs"] = []any{map[string]any{"name": " document "}, map[string]any{"name": "document"}}
|
||||||
|
_, err = load(mapping("duplicate inputs", map[string]any{"prompts": []any{definition}}), nil)
|
||||||
|
if err == nil || !strings.Contains(err.Error(), "/prompts/0/inputs/1") || !strings.Contains(err.Error(), "duplicated") {
|
||||||
|
t.Fatalf("duplicate normalized names were not rejected: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -3,9 +3,15 @@ package configuration
|
|||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/domain"
|
"go.maximumdirect.net/promptkit/internal/domain"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// CollectionIdentity is the captured metadata for one final collection entry.
|
||||||
|
type CollectionIdentity struct {
|
||||||
|
Namespace string
|
||||||
|
ReleaseVersion *string
|
||||||
|
}
|
||||||
|
|
||||||
func (state *loaded) ListProfiles(ctx context.Context) ([]string, error) {
|
func (state *loaded) ListProfiles(ctx context.Context) ([]string, error) {
|
||||||
if err := ctx.Err(); err != nil {
|
if err := ctx.Err(); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
@@ -17,6 +23,55 @@ func (state *loaded) ListProfiles(ctx context.Context) ([]string, error) {
|
|||||||
return profiles, nil
|
return profiles, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (state *loaded) ListBackends(ctx context.Context) ([]string, error) {
|
||||||
|
if err := ctx.Err(); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
backends := append([]string(nil), state.backendIDs...)
|
||||||
|
if err := ctx.Err(); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return backends, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (state *loaded) ListNamespaces(ctx context.Context, kinds []string) ([]string, error) {
|
||||||
|
if err := ctx.Err(); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
selected := kinds
|
||||||
|
if len(selected) == 0 {
|
||||||
|
selected = []string{"backend", "profile", "prompt"}
|
||||||
|
}
|
||||||
|
set := make(map[string]struct{})
|
||||||
|
for _, kind := range selected {
|
||||||
|
for _, namespace := range state.namespaces[kind] {
|
||||||
|
set[namespace] = struct{}{}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
namespaces := sortedKeys(set)
|
||||||
|
if err := ctx.Err(); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return namespaces, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (state *loaded) ListCollections(ctx context.Context) ([]CollectionIdentity, error) {
|
||||||
|
if err := ctx.Err(); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
collections := make([]CollectionIdentity, len(state.collections))
|
||||||
|
for index, collection := range state.collections {
|
||||||
|
collections[index] = CollectionIdentity{
|
||||||
|
Namespace: collection.Namespace,
|
||||||
|
ReleaseVersion: stringPointerValue(collection.ReleaseVersion),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if err := ctx.Err(); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return collections, nil
|
||||||
|
}
|
||||||
|
|
||||||
func (state *loaded) ListPrompts(ctx context.Context) ([]domain.PromptIdentity, error) {
|
func (state *loaded) ListPrompts(ctx context.Context) ([]domain.PromptIdentity, error) {
|
||||||
if err := ctx.Err(); err != nil {
|
if err := ctx.Err(); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
|
|||||||
@@ -6,33 +6,31 @@ import (
|
|||||||
"reflect"
|
"reflect"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/ConfigKit"
|
"go.maximumdirect.net/configkit"
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/domain"
|
"go.maximumdirect.net/promptkit/internal/domain"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestLoadedListsSortedEffectiveIdentities(t *testing.T) {
|
func TestLoadedListsSortedEffectiveIdentities(t *testing.T) {
|
||||||
state, err := Load(mapping("identities", map[string]any{
|
state, err := Load(mapping("identities", map[string]any{
|
||||||
"backends": map[string]any{
|
"backends": []any{map[string]any{"id": "local", "endpoint": "http://localhost:8080/v1"}},
|
||||||
"local": map[string]any{"endpoint": "http://localhost:8080/v1"},
|
"collections": map[string]any{
|
||||||
},
|
"z": map[string]any{"profiles": []any{map[string]any{"id": "profile", "backend": "local", "model": "z-model"}}, "prompts": []any{listingPromptDefinition("prompt")}},
|
||||||
"profiles": map[string]any{
|
"partial": map[string]any{"profiles": []any{map[string]any{"id": "profile", "backend": "local"}}},
|
||||||
"z/profile": map[string]any{"backend": "local", "model": "z-model"},
|
"a": map[string]any{"profiles": []any{map[string]any{"id": "profile", "backend": "local", "model": "a-model"}}, "prompts": []any{listingPromptDefinition("prompt")}},
|
||||||
"partial/profile": map[string]any{"backend": "local"},
|
" z": map[string]any{"profiles": []any{map[string]any{"id": "profile ", "backend": "local", "model": "spaced-model"}}, "prompts": []any{listingPromptDefinition("prompt ")}},
|
||||||
"a/profile": map[string]any{"backend": "local", "model": "a-model"},
|
|
||||||
" z/profile ": map[string]any{"backend": "local", "model": "spaced-model"},
|
|
||||||
},
|
|
||||||
"prompts": map[string]any{
|
|
||||||
"z/prompt": map[string]any{"v1": listingPromptDefinition()},
|
|
||||||
"a/prompt": map[string]any{"v1": listingPromptDefinition()},
|
|
||||||
" z/prompt ": map[string]any{
|
|
||||||
"2": listingPromptDefinition(),
|
|
||||||
"10": listingPromptDefinition(),
|
|
||||||
},
|
|
||||||
},
|
},
|
||||||
}), nil)
|
}), nil)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
|
backends, err := state.ListBackends(context.Background())
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
wantBackends := []string{"local"}
|
||||||
|
if !reflect.DeepEqual(backends, wantBackends) {
|
||||||
|
t.Fatalf("backend IDs = %#v, want %#v", backends, wantBackends)
|
||||||
|
}
|
||||||
|
|
||||||
profiles, err := state.ListProfiles(context.Background())
|
profiles, err := state.ListProfiles(context.Background())
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -48,10 +46,9 @@ func TestLoadedListsSortedEffectiveIdentities(t *testing.T) {
|
|||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
wantPrompts := []domain.PromptIdentity{
|
wantPrompts := []domain.PromptIdentity{
|
||||||
{ID: " z/prompt ", Version: "10"},
|
{ID: " z/prompt "},
|
||||||
{ID: " z/prompt ", Version: "2"},
|
{ID: "a/prompt"},
|
||||||
{ID: "a/prompt", Version: "v1"},
|
{ID: "z/prompt"},
|
||||||
{ID: "z/prompt", Version: "v1"},
|
|
||||||
}
|
}
|
||||||
if !reflect.DeepEqual(prompts, wantPrompts) {
|
if !reflect.DeepEqual(prompts, wantPrompts) {
|
||||||
t.Fatalf("prompt identities = %#v, want %#v", prompts, wantPrompts)
|
t.Fatalf("prompt identities = %#v, want %#v", prompts, wantPrompts)
|
||||||
@@ -60,8 +57,9 @@ func TestLoadedListsSortedEffectiveIdentities(t *testing.T) {
|
|||||||
|
|
||||||
func TestLoadedListsAreIndependent(t *testing.T) {
|
func TestLoadedListsAreIndependent(t *testing.T) {
|
||||||
state, err := Load(mapping("identities", map[string]any{
|
state, err := Load(mapping("identities", map[string]any{
|
||||||
"profiles": map[string]any{"profile": map[string]any{}},
|
"backends": []any{map[string]any{"id": "backend", "endpoint": "https://example.test/v1"}},
|
||||||
"prompts": map[string]any{"example": map[string]any{"v1": listingPromptDefinition()}},
|
"profiles": []any{map[string]any{"id": "profile"}},
|
||||||
|
"prompts": []any{listingPromptDefinition("example")},
|
||||||
}), nil)
|
}), nil)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
@@ -73,13 +71,17 @@ func TestLoadedListsAreIndependent(t *testing.T) {
|
|||||||
}
|
}
|
||||||
profiles = append(profiles, "caller profile")
|
profiles = append(profiles, "caller profile")
|
||||||
profiles[0] = "changed profile"
|
profiles[0] = "changed profile"
|
||||||
|
backends, err := state.ListBackends(context.Background())
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
backends[0] = "changed backend"
|
||||||
|
|
||||||
prompts, err := state.ListPrompts(context.Background())
|
prompts, err := state.ListPrompts(context.Background())
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
prompts[0].ID = "changed prompt"
|
prompts[0].ID = "changed prompt"
|
||||||
prompts[0].Version = "changed version"
|
|
||||||
|
|
||||||
profiles, err = state.ListProfiles(context.Background())
|
profiles, err = state.ListProfiles(context.Background())
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -88,11 +90,15 @@ func TestLoadedListsAreIndependent(t *testing.T) {
|
|||||||
if !reflect.DeepEqual(profiles, []string{"profile"}) {
|
if !reflect.DeepEqual(profiles, []string{"profile"}) {
|
||||||
t.Fatalf("caller mutation changed profile inventory: %#v", profiles)
|
t.Fatalf("caller mutation changed profile inventory: %#v", profiles)
|
||||||
}
|
}
|
||||||
|
backends, err = state.ListBackends(context.Background())
|
||||||
|
if err != nil || !reflect.DeepEqual(backends, []string{"backend"}) {
|
||||||
|
t.Fatalf("caller mutation changed backend inventory: %#v, %v", backends, err)
|
||||||
|
}
|
||||||
prompts, err = state.ListPrompts(context.Background())
|
prompts, err = state.ListPrompts(context.Background())
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
wantPrompts := []domain.PromptIdentity{{ID: "example", Version: "v1"}}
|
wantPrompts := []domain.PromptIdentity{{ID: "example"}}
|
||||||
if !reflect.DeepEqual(prompts, wantPrompts) {
|
if !reflect.DeepEqual(prompts, wantPrompts) {
|
||||||
t.Fatalf("caller mutation changed prompt inventory: %#v", prompts)
|
t.Fatalf("caller mutation changed prompt inventory: %#v", prompts)
|
||||||
}
|
}
|
||||||
@@ -107,6 +113,10 @@ func TestLoadedListsEmptyInventory(t *testing.T) {
|
|||||||
if err != nil || len(profiles) != 0 {
|
if err != nil || len(profiles) != 0 {
|
||||||
t.Fatalf("empty profile listing = %#v, %v", profiles, err)
|
t.Fatalf("empty profile listing = %#v, %v", profiles, err)
|
||||||
}
|
}
|
||||||
|
backends, err := state.ListBackends(context.Background())
|
||||||
|
if err != nil || len(backends) != 0 {
|
||||||
|
t.Fatalf("empty backend listing = %#v, %v", backends, err)
|
||||||
|
}
|
||||||
prompts, err := state.ListPrompts(context.Background())
|
prompts, err := state.ListPrompts(context.Background())
|
||||||
if err != nil || len(prompts) != 0 {
|
if err != nil || len(prompts) != 0 {
|
||||||
t.Fatalf("empty prompt listing = %#v, %v", prompts, err)
|
t.Fatalf("empty prompt listing = %#v, %v", prompts, err)
|
||||||
@@ -115,8 +125,8 @@ func TestLoadedListsEmptyInventory(t *testing.T) {
|
|||||||
|
|
||||||
func TestLoadedListsHonorCanceledContext(t *testing.T) {
|
func TestLoadedListsHonorCanceledContext(t *testing.T) {
|
||||||
state, err := Load(mapping("identities", map[string]any{
|
state, err := Load(mapping("identities", map[string]any{
|
||||||
"profiles": map[string]any{"partial": map[string]any{}},
|
"profiles": []any{map[string]any{"id": "partial"}},
|
||||||
"prompts": map[string]any{"example": map[string]any{"v1": listingPromptDefinition()}},
|
"prompts": []any{listingPromptDefinition("example")},
|
||||||
}), nil)
|
}), nil)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
@@ -128,14 +138,19 @@ func TestLoadedListsHonorCanceledContext(t *testing.T) {
|
|||||||
if !errors.Is(err, context.Canceled) || len(profiles) != 0 {
|
if !errors.Is(err, context.Canceled) || len(profiles) != 0 {
|
||||||
t.Fatalf("canceled profile listing = %#v, %v", profiles, err)
|
t.Fatalf("canceled profile listing = %#v, %v", profiles, err)
|
||||||
}
|
}
|
||||||
|
backends, err := state.ListBackends(ctx)
|
||||||
|
if !errors.Is(err, context.Canceled) || len(backends) != 0 {
|
||||||
|
t.Fatalf("canceled backend listing = %#v, %v", backends, err)
|
||||||
|
}
|
||||||
prompts, err := state.ListPrompts(ctx)
|
prompts, err := state.ListPrompts(ctx)
|
||||||
if !errors.Is(err, context.Canceled) || len(prompts) != 0 {
|
if !errors.Is(err, context.Canceled) || len(prompts) != 0 {
|
||||||
t.Fatalf("canceled prompt listing = %#v, %v", prompts, err)
|
t.Fatalf("canceled prompt listing = %#v, %v", prompts, err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func listingPromptDefinition() map[string]any {
|
func listingPromptDefinition(id string) map[string]any {
|
||||||
return map[string]any{
|
return map[string]any{
|
||||||
|
"id": id,
|
||||||
"messages": []any{map[string]any{"role": "user", "content": "Hello."}},
|
"messages": []any{map[string]any{"role": "user", "content": "Hello."}},
|
||||||
"output": map[string]any{"format": "text", "validation_mode": "basic"},
|
"output": map[string]any{"format": "text", "validation_mode": "basic"},
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -4,32 +4,60 @@ package configuration
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"net/http"
|
||||||
"regexp"
|
"regexp"
|
||||||
"sort"
|
"sort"
|
||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/ConfigKit"
|
"go.maximumdirect.net/configkit"
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/backend"
|
"go.maximumdirect.net/promptkit/internal/backend"
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/domain"
|
"go.maximumdirect.net/promptkit/internal/domain"
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/jsonvalue"
|
"go.maximumdirect.net/promptkit/internal/jsonvalue"
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/llm"
|
"go.maximumdirect.net/promptkit/internal/llm"
|
||||||
)
|
)
|
||||||
|
|
||||||
type document struct {
|
type document struct {
|
||||||
Backends map[string]backendConfig `yaml:"backends"`
|
Version *string `yaml:"version"`
|
||||||
Profiles map[string]profileConfig `yaml:"profiles"`
|
Backends []backendConfig `yaml:"backends"`
|
||||||
Prompts map[string]map[string]promptConfig `yaml:"prompts"`
|
Profiles []profileConfig `yaml:"profiles"`
|
||||||
|
Prompts []promptConfig `yaml:"prompts"`
|
||||||
|
Collections map[string]collectionConfig `yaml:"collections"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type collectionConfig struct {
|
||||||
|
ReleaseVersion *string `yaml:"release_version"`
|
||||||
|
Backends []backendConfig `yaml:"backends"`
|
||||||
|
Profiles []profileConfig `yaml:"profiles"`
|
||||||
|
Prompts []promptConfig `yaml:"prompts"`
|
||||||
}
|
}
|
||||||
|
|
||||||
type backendConfig struct {
|
type backendConfig struct {
|
||||||
Endpoint *string `yaml:"endpoint"`
|
ID string `yaml:"id"`
|
||||||
APIKeyEnv *string `yaml:"api_key_env"`
|
Endpoint *string `yaml:"endpoint"`
|
||||||
ConcurrencyLimit *int `yaml:"concurrency_limit"`
|
APIKeyEnv *string `yaml:"api_key_env"`
|
||||||
QueueCapacity *int `yaml:"queue_capacity"`
|
ConcurrencyLimit *int `yaml:"concurrency_limit"`
|
||||||
ExtraParams map[string]any `yaml:"extra_params"`
|
QueueCapacity *int `yaml:"queue_capacity"`
|
||||||
|
ExtraParams map[string]any `yaml:"extra_params"`
|
||||||
|
SmokeTests *backendSmokeTestConfig `yaml:"smoke_tests"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type backendSmokeTestConfig struct {
|
||||||
|
DefaultProfile *string `yaml:"default_profile"`
|
||||||
|
Reachability *reachabilityProbeConfig `yaml:"reachability"`
|
||||||
|
Authentication *authenticationProbeConfig `yaml:"authentication"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type reachabilityProbeConfig struct {
|
||||||
|
Endpoint *string `yaml:"endpoint"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type authenticationProbeConfig struct {
|
||||||
|
Kind *string `yaml:"kind"`
|
||||||
|
Endpoint *string `yaml:"endpoint"`
|
||||||
}
|
}
|
||||||
|
|
||||||
type profileConfig struct {
|
type profileConfig struct {
|
||||||
|
ID string `yaml:"id"`
|
||||||
Backend *string `yaml:"backend"`
|
Backend *string `yaml:"backend"`
|
||||||
Endpoint *string `yaml:"endpoint"`
|
Endpoint *string `yaml:"endpoint"`
|
||||||
Model *string `yaml:"model"`
|
Model *string `yaml:"model"`
|
||||||
@@ -45,6 +73,7 @@ type profileConfig struct {
|
|||||||
}
|
}
|
||||||
|
|
||||||
type promptConfig struct {
|
type promptConfig struct {
|
||||||
|
ID string `yaml:"id"`
|
||||||
DefaultProfile *string `yaml:"default_profile"`
|
DefaultProfile *string `yaml:"default_profile"`
|
||||||
Description *string `yaml:"description"`
|
Description *string `yaml:"description"`
|
||||||
SessionID *string `yaml:"session_id"`
|
SessionID *string `yaml:"session_id"`
|
||||||
@@ -91,20 +120,101 @@ const (
|
|||||||
|
|
||||||
type loaded struct {
|
type loaded struct {
|
||||||
result *configkit.Result[document]
|
result *configkit.Result[document]
|
||||||
|
interpreted document
|
||||||
backends map[string]map[string]fieldState
|
backends map[string]map[string]fieldState
|
||||||
profiles map[string]map[string]fieldState
|
profiles map[string]map[string]fieldState
|
||||||
promptMetadata map[string]map[string][]promptInputPresence
|
promptMetadata map[string][]promptInputPresence
|
||||||
prompts map[string]map[string]*promptEntry
|
prompts map[string]*promptEntry
|
||||||
ambiguous map[string]bool
|
|
||||||
registry *backend.Registry
|
registry *backend.Registry
|
||||||
indexedProfiles map[string]domain.ExecutionProfile
|
indexedProfiles map[string]domain.ExecutionProfile
|
||||||
|
backendIDs []string
|
||||||
profileIDs []string
|
profileIDs []string
|
||||||
promptIDs []domain.PromptIdentity
|
promptIDs []domain.PromptIdentity
|
||||||
|
namespaces map[string][]string
|
||||||
|
collections []CollectionIdentity
|
||||||
|
}
|
||||||
|
|
||||||
|
type resourceBases struct {
|
||||||
|
backends configkit.Path
|
||||||
|
profiles configkit.Path
|
||||||
|
prompts configkit.Path
|
||||||
|
}
|
||||||
|
|
||||||
|
type resourceSet struct {
|
||||||
|
isCollection bool
|
||||||
|
namespace string
|
||||||
|
bases resourceBases
|
||||||
|
backends []backendConfig
|
||||||
|
profiles []profileConfig
|
||||||
|
prompts []promptConfig
|
||||||
|
}
|
||||||
|
|
||||||
|
func rootResourceBases() resourceBases {
|
||||||
|
return resourceBases{
|
||||||
|
backends: configkit.Keys("backends"),
|
||||||
|
profiles: configkit.Keys("profiles"),
|
||||||
|
prompts: configkit.Keys("prompts"),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func resourceSets(config *document) []resourceSet {
|
||||||
|
sets := make([]resourceSet, 0, len(config.Collections)+1)
|
||||||
|
sets = append(sets, resourceSet{
|
||||||
|
bases: rootResourceBases(), backends: config.Backends, profiles: config.Profiles, prompts: config.Prompts,
|
||||||
|
})
|
||||||
|
for _, namespace := range sortedKeys(config.Collections) {
|
||||||
|
collection := config.Collections[namespace]
|
||||||
|
base := configkit.Keys("collections", namespace)
|
||||||
|
sets = append(sets, resourceSet{
|
||||||
|
isCollection: true,
|
||||||
|
namespace: namespace,
|
||||||
|
bases: resourceBases{
|
||||||
|
backends: base.Key("backends"),
|
||||||
|
profiles: base.Key("profiles"),
|
||||||
|
prompts: base.Key("prompts"),
|
||||||
|
},
|
||||||
|
backends: collection.Backends,
|
||||||
|
profiles: collection.Profiles,
|
||||||
|
prompts: collection.Prompts,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
return sets
|
||||||
|
}
|
||||||
|
|
||||||
|
func indexedResourceID(namespace, localKey string) string {
|
||||||
|
qualified, valid := domain.QualifyLocalResourceID(namespace, localKey)
|
||||||
|
if valid {
|
||||||
|
return qualified
|
||||||
|
}
|
||||||
|
if namespace == "" {
|
||||||
|
return localKey
|
||||||
|
}
|
||||||
|
return namespace + "/" + localKey
|
||||||
|
}
|
||||||
|
|
||||||
|
func indexedBackends(config *document) map[string]backendConfig {
|
||||||
|
backends := make(map[string]backendConfig)
|
||||||
|
for _, resources := range resourceSets(config) {
|
||||||
|
for _, definition := range resources.backends {
|
||||||
|
backends[indexedResourceID(resources.namespace, definition.ID)] = definition
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return backends
|
||||||
|
}
|
||||||
|
|
||||||
|
func indexedProfiles(config *document) map[string]profileConfig {
|
||||||
|
profiles := make(map[string]profileConfig)
|
||||||
|
for _, resources := range resourceSets(config) {
|
||||||
|
for _, definition := range resources.profiles {
|
||||||
|
profiles[indexedResourceID(resources.namespace, definition.ID)] = definition
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return profiles
|
||||||
}
|
}
|
||||||
|
|
||||||
var envName = regexp.MustCompile(`^[A-Za-z_][A-Za-z0-9_]*$`)
|
var envName = regexp.MustCompile(`^[A-Za-z_][A-Za-z0-9_]*$`)
|
||||||
|
|
||||||
var backendFields = []string{"endpoint", "api_key_env", "concurrency_limit", "queue_capacity", "extra_params"}
|
var backendFields = []string{"endpoint", "api_key_env", "concurrency_limit", "queue_capacity", "extra_params", "smoke_tests"}
|
||||||
var profileFields = []string{"backend", "endpoint", "model", "temperature", "top_p", "max_tokens", "timeout_seconds", "service_tier", "reasoning_effort", "api_key_env", "api_key_required", "extra_params"}
|
var profileFields = []string{"backend", "endpoint", "model", "temperature", "top_p", "max_tokens", "timeout_seconds", "service_tier", "reasoning_effort", "api_key_env", "api_key_required", "extra_params"}
|
||||||
|
|
||||||
// Load captures one immutable effective configuration for internal consumers.
|
// Load captures one immutable effective configuration for internal consumers.
|
||||||
@@ -112,28 +222,47 @@ func Load(main configkit.Input, underlays []configkit.Underlay) (*loaded, error)
|
|||||||
return load(main, underlays)
|
return load(main, underlays)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func configurationDefinition(state *loaded) configkit.Definition[document] {
|
||||||
|
return configkit.Definition[document]{
|
||||||
|
SequenceIdentities: []configkit.SequenceIdentity{
|
||||||
|
configkit.SequenceIdentityAt(configkit.Keys("backends"), "id"),
|
||||||
|
configkit.SequenceIdentityAt(configkit.Keys("profiles"), "id"),
|
||||||
|
configkit.SequenceIdentityAt(configkit.Keys("prompts"), "id"),
|
||||||
|
configkit.SequenceIdentityMatching(configkit.SequenceSelector{configkit.SequenceLiteralKey("collections"), configkit.SequenceAnyMappingKey(), configkit.SequenceLiteralKey("backends")}, "id"),
|
||||||
|
configkit.SequenceIdentityMatching(configkit.SequenceSelector{configkit.SequenceLiteralKey("collections"), configkit.SequenceAnyMappingKey(), configkit.SequenceLiteralKey("profiles")}, "id"),
|
||||||
|
configkit.SequenceIdentityMatching(configkit.SequenceSelector{configkit.SequenceLiteralKey("collections"), configkit.SequenceAnyMappingKey(), configkit.SequenceLiteralKey("prompts")}, "id"),
|
||||||
|
},
|
||||||
|
Version: &configkit.VersionRule{
|
||||||
|
Path: configkit.Keys("version"),
|
||||||
|
Check: checkConfigurationVersion,
|
||||||
|
},
|
||||||
|
Sensitive: secretProviderPath,
|
||||||
|
Resolve: func(config *document, resolution *configkit.Resolution) error {
|
||||||
|
for _, resources := range resourceSets(config) {
|
||||||
|
captureFields(resources.backends, func(v backendConfig) string { return v.ID }, resources.bases.backends, resources.namespace, backendFields, resolution, state.backends)
|
||||||
|
captureFields(resources.profiles, func(v profileConfig) string { return v.ID }, resources.bases.profiles, resources.namespace, profileFields, resolution, state.profiles)
|
||||||
|
capturePromptMetadata(resources.prompts, resources.bases.prompts, resources.namespace, resolution, state.promptMetadata)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
},
|
||||||
|
Validate: func(config *document, validation *configkit.Validation) {
|
||||||
|
state.interpreted = interpretConfiguration(config, validation)
|
||||||
|
validateEffective(&state.interpreted, validation)
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// load performs one ConfigKit lifecycle over the selected source tiers.
|
// load performs one ConfigKit lifecycle over the selected source tiers.
|
||||||
func load(main configkit.Input, underlays []configkit.Underlay) (*loaded, error) {
|
func load(main configkit.Input, underlays []configkit.Underlay) (*loaded, error) {
|
||||||
state := &loaded{
|
state := &loaded{
|
||||||
backends: make(map[string]map[string]fieldState),
|
backends: make(map[string]map[string]fieldState),
|
||||||
profiles: make(map[string]map[string]fieldState),
|
profiles: make(map[string]map[string]fieldState),
|
||||||
promptMetadata: make(map[string]map[string][]promptInputPresence),
|
promptMetadata: make(map[string][]promptInputPresence),
|
||||||
}
|
}
|
||||||
result, err := configkit.LoadLayered(main, configkit.LayeredOptions[document]{
|
result, err := configkit.LoadLayered(main, configkit.LayeredOptions[document]{
|
||||||
Underlays: underlays,
|
Underlays: underlays,
|
||||||
Definition: configkit.Definition[document]{
|
SourceVersionMode: configkit.SourceVersionModeIfPresent,
|
||||||
Secret: secretProviderPath,
|
Definition: configurationDefinition(state),
|
||||||
Resolve: func(config *document, resolution *configkit.Resolution) error {
|
|
||||||
captureFields(config.Backends, "backends", backendFields, resolution, state.backends)
|
|
||||||
captureFields(config.Profiles, "profiles", profileFields, resolution, state.profiles)
|
|
||||||
capturePromptMetadata(config.Prompts, resolution, state.promptMetadata)
|
|
||||||
resolveBackends(config.Backends, resolution)
|
|
||||||
resolveProfiles(config.Profiles, resolution)
|
|
||||||
resolvePrompts(config.Prompts, resolution)
|
|
||||||
return nil
|
|
||||||
},
|
|
||||||
Validate: validateEffective,
|
|
||||||
},
|
|
||||||
})
|
})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("load configuration: %w", err)
|
return nil, fmt.Errorf("load configuration: %w", err)
|
||||||
@@ -145,43 +274,76 @@ func load(main configkit.Input, underlays []configkit.Underlay) (*loaded, error)
|
|||||||
if err := state.buildExecutionProfiles(); err != nil {
|
if err := state.buildExecutionProfiles(); err != nil {
|
||||||
return nil, fmt.Errorf("load configuration: %w", err)
|
return nil, fmt.Errorf("load configuration: %w", err)
|
||||||
}
|
}
|
||||||
|
state.backendIDs = sortedKeys(indexedBackends(&state.interpreted))
|
||||||
state.profileIDs = sortedKeys(state.indexedProfiles)
|
state.profileIDs = sortedKeys(state.indexedProfiles)
|
||||||
for _, id := range sortedKeys(state.prompts) {
|
for _, id := range sortedKeys(state.prompts) {
|
||||||
for _, version := range sortedKeys(state.prompts[id]) {
|
state.promptIDs = append(state.promptIDs, domain.PromptIdentity{ID: id})
|
||||||
state.promptIDs = append(state.promptIDs, domain.PromptIdentity{ID: id, Version: version})
|
}
|
||||||
}
|
state.namespaces = map[string][]string{
|
||||||
|
"backend": resourceNamespaces(state.backendIDs),
|
||||||
|
"profile": resourceNamespaces(state.profileIDs),
|
||||||
|
"prompt": promptNamespaces(state.promptIDs),
|
||||||
|
}
|
||||||
|
for _, namespace := range sortedKeys(result.Config.Collections) {
|
||||||
|
collection := result.Config.Collections[namespace]
|
||||||
|
state.collections = append(state.collections, CollectionIdentity{
|
||||||
|
Namespace: namespace, ReleaseVersion: stringPointerValue(collection.ReleaseVersion),
|
||||||
|
})
|
||||||
}
|
}
|
||||||
return state, nil
|
return state, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func resourceNamespaces(ids []string) []string {
|
||||||
|
namespaces := make(map[string]struct{})
|
||||||
|
for _, id := range ids {
|
||||||
|
if namespace, _, qualified := strings.Cut(id, "/"); qualified {
|
||||||
|
namespaces[namespace] = struct{}{}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return sortedKeys(namespaces)
|
||||||
|
}
|
||||||
|
|
||||||
|
func promptNamespaces(prompts []domain.PromptIdentity) []string {
|
||||||
|
ids := make([]string, len(prompts))
|
||||||
|
for index := range prompts {
|
||||||
|
ids[index] = prompts[index].ID
|
||||||
|
}
|
||||||
|
return resourceNamespaces(ids)
|
||||||
|
}
|
||||||
|
|
||||||
|
func checkConfigurationVersion(version configkit.Version, validation *configkit.Validation) error {
|
||||||
|
if !version.Present {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if version.Null || version.Text != "2" {
|
||||||
|
validation.Error(configkit.Keys("version"), "unsupported configuration specification version")
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
type promptInputPresence struct {
|
type promptInputPresence struct {
|
||||||
contentType fieldState
|
contentType fieldState
|
||||||
description fieldState
|
description fieldState
|
||||||
}
|
}
|
||||||
|
|
||||||
func capturePromptMetadata(prompts map[string]map[string]promptConfig, resolution *configkit.Resolution, destination map[string]map[string][]promptInputPresence) {
|
func capturePromptMetadata(prompts []promptConfig, basePath configkit.Path, namespace string, resolution *configkit.Resolution, destination map[string][]promptInputPresence) {
|
||||||
for _, id := range sortedKeys(prompts) {
|
for promptIndex, prompt := range prompts {
|
||||||
if destination[id] == nil {
|
inputs := prompt.Inputs
|
||||||
destination[id] = make(map[string][]promptInputPresence, len(prompts[id]))
|
states := make([]promptInputPresence, len(inputs))
|
||||||
}
|
base := basePath.Index(promptIndex).Key("inputs")
|
||||||
for _, version := range sortedKeys(prompts[id]) {
|
for index := range inputs {
|
||||||
inputs := prompts[id][version].Inputs
|
path := base.Index(index)
|
||||||
states := make([]promptInputPresence, len(inputs))
|
states[index] = promptInputPresence{
|
||||||
base := configkit.Keys("prompts", id, version, "inputs")
|
contentType: captureFieldState(path.Key("content_type"), resolution),
|
||||||
for index := range inputs {
|
description: captureFieldState(path.Key("description"), resolution),
|
||||||
path := base.Index(index)
|
|
||||||
states[index] = promptInputPresence{
|
|
||||||
contentType: captureFieldState(path.Key("content_type"), resolution),
|
|
||||||
description: captureFieldState(path.Key("description"), resolution),
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
destination[id][version] = states
|
|
||||||
}
|
}
|
||||||
|
destination[indexedResourceID(namespace, prompt.ID)] = states
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func captureFieldState(path configkit.Path, resolution *configkit.Resolution) fieldState {
|
func captureFieldState(path configkit.Path, resolution *configkit.Resolution) fieldState {
|
||||||
info, exists := resolution.InputInfo(path)
|
info, exists := resolution.EntryInfo(path)
|
||||||
switch {
|
switch {
|
||||||
case !exists || !info.Explicit:
|
case !exists || !info.Explicit:
|
||||||
return fieldAbsent
|
return fieldAbsent
|
||||||
@@ -192,11 +354,11 @@ func captureFieldState(path configkit.Path, resolution *configkit.Resolution) fi
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func captureFields[T any](entries map[string]T, collection string, fields []string, resolution *configkit.Resolution, destination map[string]map[string]fieldState) {
|
func captureFields[T any](entries []T, identity func(T) string, basePath configkit.Path, namespace string, fields []string, resolution *configkit.Resolution, destination map[string]map[string]fieldState) {
|
||||||
for id := range entries {
|
for index, entry := range entries {
|
||||||
states := make(map[string]fieldState, len(fields))
|
states := make(map[string]fieldState, len(fields))
|
||||||
for _, field := range fields {
|
for _, field := range fields {
|
||||||
info, exists := resolution.InputInfo(configkit.Keys(collection, id, field))
|
info, exists := resolution.EntryInfo(basePath.Index(index).Key(field))
|
||||||
switch {
|
switch {
|
||||||
case !exists || !info.Explicit:
|
case !exists || !info.Explicit:
|
||||||
states[field] = fieldAbsent
|
states[field] = fieldAbsent
|
||||||
@@ -206,7 +368,7 @@ func captureFields[T any](entries map[string]T, collection string, fields []stri
|
|||||||
states[field] = fieldValue
|
states[field] = fieldValue
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
destination[id] = states
|
destination[indexedResourceID(namespace, identity(entry))] = states
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -219,132 +381,215 @@ func sortedKeys[T any](entries map[string]T) []string {
|
|||||||
return keys
|
return keys
|
||||||
}
|
}
|
||||||
|
|
||||||
func normalizeString(value **string, path configkit.Path, resolution *configkit.Resolution, normalized string) bool {
|
func interpretConfiguration(config *document, validation *configkit.Validation) document {
|
||||||
if value != nil && *value != nil && **value != normalized {
|
interpreted := *config
|
||||||
configkit.Normalize(resolution, path, value, &normalized, "normalize configuration value")
|
interpreted.Backends = interpretBackends(config.Backends, configkit.Keys("backends"), validation)
|
||||||
return true
|
interpreted.Profiles = interpretProfiles(config.Profiles, configkit.Keys("profiles"), validation)
|
||||||
|
interpreted.Prompts = interpretPrompts(config.Prompts)
|
||||||
|
if config.Collections != nil {
|
||||||
|
interpreted.Collections = make(map[string]collectionConfig, len(config.Collections))
|
||||||
|
for namespace, original := range config.Collections {
|
||||||
|
collection := original
|
||||||
|
base := configkit.Keys("collections", namespace)
|
||||||
|
collection.Backends = interpretBackends(original.Backends, base.Key("backends"), validation)
|
||||||
|
collection.Profiles = interpretProfiles(original.Profiles, base.Key("profiles"), validation)
|
||||||
|
collection.Prompts = interpretPrompts(original.Prompts)
|
||||||
|
interpreted.Collections[namespace] = collection
|
||||||
|
}
|
||||||
}
|
}
|
||||||
return false
|
return interpreted
|
||||||
}
|
}
|
||||||
|
|
||||||
func resolveBackends(backends map[string]backendConfig, resolution *configkit.Resolution) {
|
func interpretBackends(source []backendConfig, basePath configkit.Path, validation *configkit.Validation) []backendConfig {
|
||||||
for _, id := range sortedKeys(backends) {
|
if source == nil {
|
||||||
backend := backends[id]
|
return nil
|
||||||
base := configkit.Keys("backends", id)
|
}
|
||||||
|
backends := append([]backendConfig{}, source...)
|
||||||
|
for index := range backends {
|
||||||
|
backend := &backends[index]
|
||||||
|
base := basePath.Index(index)
|
||||||
if backend.Endpoint != nil {
|
if backend.Endpoint != nil {
|
||||||
endpoint, err := domain.NormalizeOpenAICompatibleBaseEndpoint(*backend.Endpoint)
|
endpoint, err := domain.NormalizeOpenAICompatibleBaseEndpoint(*backend.Endpoint)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
resolution.Error(base.Key("endpoint"), err.Error())
|
validation.Error(base.Key("endpoint"), err.Error())
|
||||||
} else {
|
} else {
|
||||||
normalizeString(&backend.Endpoint, base.Key("endpoint"), resolution, endpoint)
|
backend.Endpoint = &endpoint
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
if backend.APIKeyEnv != nil {
|
if backend.APIKeyEnv != nil {
|
||||||
normalizeString(&backend.APIKeyEnv, base.Key("api_key_env"), resolution, strings.TrimSpace(*backend.APIKeyEnv))
|
value := strings.TrimSpace(*backend.APIKeyEnv)
|
||||||
|
backend.APIKeyEnv = &value
|
||||||
|
}
|
||||||
|
if backend.SmokeTests != nil {
|
||||||
|
smokeTests := *backend.SmokeTests
|
||||||
|
backend.SmokeTests = &smokeTests
|
||||||
|
smokePath := base.Key("smoke_tests")
|
||||||
|
if smokeTests.Reachability != nil {
|
||||||
|
reachability := *smokeTests.Reachability
|
||||||
|
smokeTests.Reachability = &reachability
|
||||||
|
normalizeDiagnosticEndpoint(&reachability.Endpoint, smokePath.Key("reachability").Key("endpoint"), validation)
|
||||||
|
}
|
||||||
|
if smokeTests.Authentication != nil {
|
||||||
|
authentication := *smokeTests.Authentication
|
||||||
|
smokeTests.Authentication = &authentication
|
||||||
|
if authentication.Kind != nil {
|
||||||
|
kind := strings.ToLower(strings.TrimSpace(*authentication.Kind))
|
||||||
|
authentication.Kind = &kind
|
||||||
|
}
|
||||||
|
normalizeDiagnosticEndpoint(&authentication.Endpoint, smokePath.Key("authentication").Key("endpoint"), validation)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
if backend.ConcurrencyLimit != nil && *backend.ConcurrencyLimit > 0 && backend.QueueCapacity == nil {
|
if backend.ConcurrencyLimit != nil && *backend.ConcurrencyLimit > 0 && backend.QueueCapacity == nil {
|
||||||
capacity := 1024
|
capacity := 1024
|
||||||
if resolution.IsExplicit(base.Key("queue_capacity")) {
|
backend.QueueCapacity = &capacity
|
||||||
configkit.Normalize(resolution, base.Key("queue_capacity"), &backend.QueueCapacity, &capacity, "select default queue capacity")
|
|
||||||
} else {
|
|
||||||
configkit.Default(resolution, base.Key("queue_capacity"), &backend.QueueCapacity, &capacity, "select default queue capacity")
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
backends[id] = backend
|
|
||||||
}
|
}
|
||||||
|
return backends
|
||||||
}
|
}
|
||||||
|
|
||||||
func resolveProfiles(profiles map[string]profileConfig, resolution *configkit.Resolution) {
|
func normalizeDiagnosticEndpoint(value **string, path configkit.Path, validation *configkit.Validation) {
|
||||||
for _, id := range sortedKeys(profiles) {
|
if value == nil || *value == nil {
|
||||||
profile := profiles[id]
|
return
|
||||||
base := configkit.Keys("profiles", id)
|
}
|
||||||
|
normalized := strings.TrimSpace(**value)
|
||||||
|
request, err := http.NewRequest(http.MethodGet, normalized, nil)
|
||||||
|
if normalized == "" || err != nil || request.URL == nil ||
|
||||||
|
(strings.ToLower(request.URL.Scheme) != "http" && strings.ToLower(request.URL.Scheme) != "https") ||
|
||||||
|
request.URL.Hostname() == "" {
|
||||||
|
validation.Error(path, "diagnostic endpoint must be an absolute HTTP(S) URL with a host")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
*value = &normalized
|
||||||
|
}
|
||||||
|
|
||||||
|
func interpretProfiles(source []profileConfig, basePath configkit.Path, validation *configkit.Validation) []profileConfig {
|
||||||
|
if source == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
profiles := append([]profileConfig{}, source...)
|
||||||
|
for index := range profiles {
|
||||||
|
profile := &profiles[index]
|
||||||
|
base := basePath.Index(index)
|
||||||
if profile.Endpoint != nil && *profile.Endpoint != "" {
|
if profile.Endpoint != nil && *profile.Endpoint != "" {
|
||||||
endpoint, err := domain.NormalizeOpenAICompatibleBaseEndpoint(*profile.Endpoint)
|
endpoint, err := domain.NormalizeOpenAICompatibleBaseEndpoint(*profile.Endpoint)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
resolution.Error(base.Key("endpoint"), err.Error())
|
validation.Error(base.Key("endpoint"), err.Error())
|
||||||
} else {
|
} else {
|
||||||
normalizeString(&profile.Endpoint, base.Key("endpoint"), resolution, endpoint)
|
profile.Endpoint = &endpoint
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
for _, field := range []struct {
|
for _, value := range []**string{&profile.ServiceTier, &profile.ReasoningEffort, &profile.APIKeyEnv} {
|
||||||
name string
|
if *value != nil {
|
||||||
value **string
|
normalized := strings.TrimSpace(**value)
|
||||||
}{
|
*value = &normalized
|
||||||
{"service_tier", &profile.ServiceTier},
|
|
||||||
{"reasoning_effort", &profile.ReasoningEffort},
|
|
||||||
{"api_key_env", &profile.APIKeyEnv},
|
|
||||||
} {
|
|
||||||
if *field.value != nil {
|
|
||||||
normalizeString(field.value, base.Key(field.name), resolution, strings.TrimSpace(**field.value))
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
profiles[id] = profile
|
|
||||||
}
|
}
|
||||||
|
return profiles
|
||||||
}
|
}
|
||||||
|
|
||||||
func validateEffective(config *document, validation *configkit.Validation) {
|
func validateEffective(config *document, validation *configkit.Validation) {
|
||||||
for _, id := range sortedKeys(config.Backends) {
|
sets := resourceSets(config)
|
||||||
backend := config.Backends[id]
|
backendIDs := make(map[string]struct{})
|
||||||
base := configkit.Keys("backends", id)
|
for _, resources := range sets {
|
||||||
if strings.TrimSpace(id) == "" {
|
if resources.isCollection && !domain.IsValidResourceNamespace(resources.namespace) {
|
||||||
validation.Error(base, "backend ID must not be blank")
|
validation.Error(configkit.Keys("collections", resources.namespace), "collection namespace must be nonblank and contain no slash")
|
||||||
}
|
}
|
||||||
if backend.Endpoint == nil || *backend.Endpoint == "" {
|
for _, backend := range resources.backends {
|
||||||
validation.Error(base.Key("endpoint"), "endpoint is required")
|
backendIDs[indexedResourceID(resources.namespace, backend.ID)] = struct{}{}
|
||||||
}
|
}
|
||||||
if backend.APIKeyEnv != nil && *backend.APIKeyEnv != "" && !envName.MatchString(*backend.APIKeyEnv) {
|
|
||||||
validation.Error(base.Key("api_key_env"), "environment variable name is invalid")
|
|
||||||
}
|
|
||||||
if backend.ConcurrencyLimit != nil && *backend.ConcurrencyLimit < 0 {
|
|
||||||
validation.Error(base.Key("concurrency_limit"), "concurrency limit must not be negative")
|
|
||||||
}
|
|
||||||
if backend.QueueCapacity != nil {
|
|
||||||
if *backend.QueueCapacity < 0 {
|
|
||||||
validation.Error(base.Key("queue_capacity"), "queue capacity must not be negative")
|
|
||||||
}
|
|
||||||
if backend.ConcurrencyLimit == nil || *backend.ConcurrencyLimit <= 0 {
|
|
||||||
validation.Error(base.Key("queue_capacity"), "queue capacity requires a positive concurrency limit")
|
|
||||||
} else if *backend.QueueCapacity > int(^uint(0)>>1)-*backend.ConcurrencyLimit {
|
|
||||||
validation.Error(base.Key("queue_capacity"), "total capacity overflows int")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
validateExtraParams(backend.ExtraParams, base.Key("extra_params"), true, validation)
|
|
||||||
}
|
}
|
||||||
for _, id := range sortedKeys(config.Profiles) {
|
for _, resources := range sets {
|
||||||
profile := config.Profiles[id]
|
for index, backend := range resources.backends {
|
||||||
base := configkit.Keys("profiles", id)
|
base := resources.bases.backends.Index(index)
|
||||||
if strings.TrimSpace(id) == "" {
|
if !domain.IsValidLocalResourceKey(backend.ID) {
|
||||||
validation.Error(base, "profile ID must not be blank")
|
validation.Error(base.Key("id"), "backend ID must be a nonblank local key without a slash")
|
||||||
}
|
}
|
||||||
if profile.Backend != nil && *profile.Backend != "" {
|
if backend.Endpoint == nil || *backend.Endpoint == "" {
|
||||||
if _, exists := config.Backends[*profile.Backend]; !exists {
|
validation.Error(base.Key("endpoint"), "endpoint is required")
|
||||||
validation.Error(base.Key("backend"), "backend is not defined")
|
}
|
||||||
|
if backend.APIKeyEnv != nil && *backend.APIKeyEnv != "" && !envName.MatchString(*backend.APIKeyEnv) {
|
||||||
|
validation.Error(base.Key("api_key_env"), "environment variable name is invalid")
|
||||||
|
}
|
||||||
|
if backend.ConcurrencyLimit != nil && *backend.ConcurrencyLimit < 0 {
|
||||||
|
validation.Error(base.Key("concurrency_limit"), "concurrency limit must not be negative")
|
||||||
|
}
|
||||||
|
if backend.QueueCapacity != nil {
|
||||||
|
if *backend.QueueCapacity < 0 {
|
||||||
|
validation.Error(base.Key("queue_capacity"), "queue capacity must not be negative")
|
||||||
|
}
|
||||||
|
if backend.ConcurrencyLimit == nil || *backend.ConcurrencyLimit <= 0 {
|
||||||
|
validation.Error(base.Key("queue_capacity"), "queue capacity requires a positive concurrency limit")
|
||||||
|
} else if *backend.QueueCapacity > int(^uint(0)>>1)-*backend.ConcurrencyLimit {
|
||||||
|
validation.Error(base.Key("queue_capacity"), "total capacity overflows int")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
validateExtraParams(backend.ExtraParams, base.Key("extra_params"), true, validation)
|
||||||
|
if smokeTests := backend.SmokeTests; smokeTests != nil {
|
||||||
|
smokePath := base.Key("smoke_tests")
|
||||||
|
if smokeTests.DefaultProfile != nil {
|
||||||
|
if strings.TrimSpace(*smokeTests.DefaultProfile) == "" {
|
||||||
|
validation.Error(smokePath.Key("default_profile"), "default profile must not be blank")
|
||||||
|
} else if !domain.IsValidResourceID(*smokeTests.DefaultProfile) {
|
||||||
|
validation.Error(smokePath.Key("default_profile"), "default profile reference is malformed")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if authentication := smokeTests.Authentication; authentication != nil {
|
||||||
|
kindPath := smokePath.Key("authentication").Key("kind")
|
||||||
|
if authentication.Kind == nil {
|
||||||
|
validation.Error(kindPath, "authentication kind is required")
|
||||||
|
} else if *authentication.Kind != "none" && *authentication.Kind != "openrouter_key" {
|
||||||
|
validation.Error(kindPath, "authentication kind must be none or openrouter_key")
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
if profile.Model != nil && *profile.Model != "" && strings.TrimSpace(*profile.Model) == "" {
|
for index, profile := range resources.profiles {
|
||||||
validation.Error(base.Key("model"), "model must not be blank")
|
base := resources.bases.profiles.Index(index)
|
||||||
|
if !domain.IsValidLocalResourceKey(profile.ID) {
|
||||||
|
validation.Error(base.Key("id"), "profile ID must be a nonblank local key without a slash")
|
||||||
|
}
|
||||||
|
if profile.Backend != nil && *profile.Backend != "" {
|
||||||
|
if !domain.IsValidResourceID(*profile.Backend) {
|
||||||
|
validation.Error(base.Key("backend"), "backend reference is malformed")
|
||||||
|
} else if _, exists := backendIDs[*profile.Backend]; !exists {
|
||||||
|
validation.Error(base.Key("backend"), "backend is not defined")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if profile.Model != nil && *profile.Model != "" && strings.TrimSpace(*profile.Model) == "" {
|
||||||
|
validation.Error(base.Key("model"), "model must not be blank")
|
||||||
|
}
|
||||||
|
if profile.Temperature != nil {
|
||||||
|
if err := domain.ValidateExecutionTargetSettings(domain.ExecutionTarget{Temperature: *profile.Temperature}); err != nil {
|
||||||
|
validation.Error(base.Key("temperature"), err.Error())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if profile.TopP != nil {
|
||||||
|
if err := domain.ValidateExecutionTargetSettings(domain.ExecutionTarget{TopP: *profile.TopP}); err != nil {
|
||||||
|
validation.Error(base.Key("top_p"), err.Error())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if profile.MaxTokens != nil {
|
||||||
|
if err := domain.ValidateExecutionTargetSettings(domain.ExecutionTarget{MaxTokens: *profile.MaxTokens}); err != nil {
|
||||||
|
validation.Error(base.Key("max_tokens"), err.Error())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if profile.TimeoutSeconds != nil {
|
||||||
|
if err := domain.ValidateExecutionTargetSettings(domain.ExecutionTarget{TimeoutSeconds: *profile.TimeoutSeconds}); err != nil {
|
||||||
|
validation.Error(base.Key("timeout_seconds"), err.Error())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
validateExtraParams(profile.ExtraParams, base.Key("extra_params"), false, validation)
|
||||||
}
|
}
|
||||||
if profile.Temperature != nil {
|
for index, prompt := range resources.prompts {
|
||||||
if err := domain.ValidateExecutionTargetSettings(domain.ExecutionTarget{Temperature: *profile.Temperature}); err != nil {
|
base := resources.bases.prompts.Index(index)
|
||||||
validation.Error(base.Key("temperature"), err.Error())
|
if !domain.IsValidLocalResourceKey(prompt.ID) {
|
||||||
|
validation.Error(base.Key("id"), "prompt ID must be a nonblank local key without a slash")
|
||||||
|
}
|
||||||
|
if prompt.DefaultProfile != nil && *prompt.DefaultProfile != "" && !domain.IsValidResourceID(*prompt.DefaultProfile) {
|
||||||
|
validation.Error(base.Key("default_profile"), "default profile reference is malformed")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
if profile.TopP != nil {
|
|
||||||
if err := domain.ValidateExecutionTargetSettings(domain.ExecutionTarget{TopP: *profile.TopP}); err != nil {
|
|
||||||
validation.Error(base.Key("top_p"), err.Error())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if profile.MaxTokens != nil {
|
|
||||||
if err := domain.ValidateExecutionTargetSettings(domain.ExecutionTarget{MaxTokens: *profile.MaxTokens}); err != nil {
|
|
||||||
validation.Error(base.Key("max_tokens"), err.Error())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if profile.TimeoutSeconds != nil {
|
|
||||||
if err := domain.ValidateExecutionTargetSettings(domain.ExecutionTarget{TimeoutSeconds: *profile.TimeoutSeconds}); err != nil {
|
|
||||||
validation.Error(base.Key("timeout_seconds"), err.Error())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
validateExtraParams(profile.ExtraParams, base.Key("extra_params"), false, validation)
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -1,100 +1,742 @@
|
|||||||
package configuration
|
package configuration
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"context"
|
||||||
"errors"
|
"errors"
|
||||||
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/ConfigKit"
|
"go.maximumdirect.net/configkit"
|
||||||
)
|
)
|
||||||
|
|
||||||
func mapping(label string, values map[string]any) configkit.Input {
|
func mapping(label string, values map[string]any) configkit.Input {
|
||||||
return configkit.Input{Source: configkit.Mapping(label, values)}
|
return configkit.Input{Source: configkit.Mapping(label, values)}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestLoadComposesLiteralKeysAndEffectivePresence(t *testing.T) {
|
func TestLoadIdentifiedResourceLists(t *testing.T) {
|
||||||
base := mapping("defaults", map[string]any{
|
for _, header := range []bool{false, true} {
|
||||||
"backends": map[string]any{
|
values := map[string]any{
|
||||||
"local.v1": map[string]any{"endpoint": "http://localhost:8080/v1", "concurrency_limit": 2},
|
"backends": []any{map[string]any{"id": "local", "endpoint": "https://example.invalid/v1"}},
|
||||||
},
|
"collections": map[string]any{"team": map[string]any{
|
||||||
"profiles": map[string]any{
|
"backends": []any{map[string]any{"id": "local", "endpoint": "https://example.invalid/v1"}},
|
||||||
"base/one": map[string]any{"backend": "local.v1", "temperature": 0.8, "top_p": 0.9, "api_key_required": true,
|
}},
|
||||||
"extra_params": map[string]any{"provider": map[string]any{"first": 1, "second": 2}}},
|
}
|
||||||
"child.v1": map[string]any{"extends": "base/one"},
|
if header {
|
||||||
},
|
values["version"] = "2"
|
||||||
"prompts": map[string]any{"invoice/summary": map[string]any{"v1.0": map[string]any{
|
}
|
||||||
"messages": []any{map[string]any{"role": "user", "content": "Summarize."}},
|
loaded, err := load(mapping("identified resources", values), nil)
|
||||||
"output": map[string]any{"format": "text", "validation_mode": "basic"},
|
if err != nil {
|
||||||
}}},
|
t.Fatalf("load identified resources with header %t: %v", header, err)
|
||||||
})
|
}
|
||||||
overlay := mapping("operator", map[string]any{
|
if loaded.result.Config.Backends[0].ID != "local" || loaded.result.Config.Collections["team"].Backends[0].ID != "local" {
|
||||||
"backends": map[string]any{"local.v1": map[string]any{"queue_capacity": 0}},
|
t.Fatal("identified root and collection resources were not retained")
|
||||||
"profiles": map[string]any{"child.v1": map[string]any{
|
}
|
||||||
"temperature": 0, "top_p": nil, "api_key_required": false,
|
}
|
||||||
"extra_params": map[string]any{"provider": map[string]any{"second": 3}},
|
}
|
||||||
}},
|
|
||||||
})
|
func TestIdentifiedResourcesComposeAcrossNamespacesAndKinds(t *testing.T) {
|
||||||
loaded, err := load(configkit.Input{Source: configkit.NoSource()}, []configkit.Underlay{
|
resources := func() map[string]any {
|
||||||
{Inputs: []configkit.Input{base}}, {Inputs: []configkit.Input{overlay}},
|
return map[string]any{
|
||||||
})
|
"backends": []any{
|
||||||
|
map[string]any{"id": "shared", "endpoint": "https://example.invalid/v1"},
|
||||||
|
map[string]any{"id": "child", "extends": map[string]any{"id": "shared"}},
|
||||||
|
},
|
||||||
|
"profiles": []any{
|
||||||
|
map[string]any{"id": "shared", "model": "model"},
|
||||||
|
map[string]any{"id": "child", "extends": map[string]any{"id": "shared"}},
|
||||||
|
},
|
||||||
|
"prompts": []any{
|
||||||
|
map[string]any{"id": "shared", "messages": []any{map[string]any{"role": "user", "content": "inherited"}},
|
||||||
|
"output": map[string]any{"format": "text", "validation_mode": "basic"}},
|
||||||
|
map[string]any{"id": "child", "extends": map[string]any{"id": "shared"}},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
values := resources()
|
||||||
|
values["collections"] = map[string]any{"*": resources(), "123": resources()}
|
||||||
|
state, err := load(mapping("identified namespaces", values), nil)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
profile := loaded.result.Config.Profiles["child.v1"]
|
for _, prefix := range []string{"", "*/", "123/"} {
|
||||||
|
backend, err := state.registry.GetBackend(prefix + "child")
|
||||||
|
if err != nil || backend.ID != prefix+"child" || backend.Endpoint != "https://example.invalid/v1" {
|
||||||
|
t.Fatalf("inherited backend %q = %+v, %v", prefix, backend, err)
|
||||||
|
}
|
||||||
|
profile, err := state.GetProfileIdentity(context.Background(), prefix+"child")
|
||||||
|
if err != nil || profile != prefix+"child" {
|
||||||
|
t.Fatalf("inherited profile %q = %q, %v", prefix, profile, err)
|
||||||
|
}
|
||||||
|
definition, _, err := state.prompt(prefix + "child")
|
||||||
|
if err != nil || definition.ID != prefix+"child" || len(definition.Templates) != 1 || definition.Templates[0].Content != "inherited" {
|
||||||
|
t.Fatalf("inherited prompt %q = %+v, %v", prefix, definition, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestIdentifiedResourcesRejectInvalidInheritance(t *testing.T) {
|
||||||
|
for _, kind := range []string{"backends", "profiles", "prompts"} {
|
||||||
|
for name, records := range map[string][]any{
|
||||||
|
"missing": {map[string]any{"id": "child", "extends": map[string]any{"id": "missing"}}},
|
||||||
|
"self": {map[string]any{"id": "child", "extends": map[string]any{"id": "child"}}},
|
||||||
|
"cycle": {
|
||||||
|
map[string]any{"id": "first", "extends": map[string]any{"id": "second"}},
|
||||||
|
map[string]any{"id": "second", "extends": map[string]any{"id": "first"}},
|
||||||
|
},
|
||||||
|
} {
|
||||||
|
t.Run(kind+"/"+name, func(t *testing.T) {
|
||||||
|
_, err := load(mapping("invalid inheritance", map[string]any{kind: records}), nil)
|
||||||
|
var loadErr *configkit.LoadError
|
||||||
|
if !errors.As(err, &loadErr) {
|
||||||
|
t.Fatalf("load error = %v, want an upstream inheritance diagnostic", err)
|
||||||
|
}
|
||||||
|
for _, diagnostic := range loadErr.Diagnostics() {
|
||||||
|
if diagnostic.Code == configkit.CodeInheritanceMissing || diagnostic.Code == configkit.CodeInheritanceCycle {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
t.Fatalf("missing inheritance diagnostic: %+v", loadErr.Diagnostics())
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestIdentifiedResourcesRejectInvalidLocalIDs(t *testing.T) {
|
||||||
|
for _, kind := range []string{"backends", "profiles", "prompts"} {
|
||||||
|
for _, test := range []struct {
|
||||||
|
name string
|
||||||
|
record map[string]any
|
||||||
|
}{
|
||||||
|
{name: "missing", record: map[string]any{}},
|
||||||
|
{name: "null", record: map[string]any{"id": nil}},
|
||||||
|
{name: "non-string", record: map[string]any{"id": 42}},
|
||||||
|
{name: "blank", record: map[string]any{"id": " "}},
|
||||||
|
{name: "slash", record: map[string]any{"id": "not/local"}},
|
||||||
|
} {
|
||||||
|
t.Run(kind+"/"+test.name, func(t *testing.T) {
|
||||||
|
_, err := load(mapping("invalid resource ID", map[string]any{kind: []any{test.record}}), nil)
|
||||||
|
var loadErr *configkit.LoadError
|
||||||
|
if !errors.As(err, &loadErr) || len(loadErr.Diagnostics()) == 0 {
|
||||||
|
t.Fatalf("load error = %v, want a path-aware error", err)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestIdentifiedResourcesRejectDuplicateStrictPeers(t *testing.T) {
|
||||||
|
for _, kind := range []string{"backends", "profiles", "prompts"} {
|
||||||
|
for _, namespace := range []string{"", "*"} {
|
||||||
|
t.Run(kind+"/"+namespace, func(t *testing.T) {
|
||||||
|
values := func() map[string]any {
|
||||||
|
records := []any{map[string]any{"id": "duplicate"}}
|
||||||
|
if namespace == "" {
|
||||||
|
return map[string]any{kind: records}
|
||||||
|
}
|
||||||
|
return map[string]any{"collections": map[string]any{namespace: map[string]any{kind: records}}}
|
||||||
|
}
|
||||||
|
_, err := load(configkit.Input{Source: configkit.NoSource()}, []configkit.Underlay{{Inputs: []configkit.Input{
|
||||||
|
mapping("first", values()), mapping("second", values()),
|
||||||
|
}}})
|
||||||
|
var loadErr *configkit.LoadError
|
||||||
|
if !errors.As(err, &loadErr) {
|
||||||
|
t.Fatalf("load error = %v, want an upstream duplicate diagnostic", err)
|
||||||
|
}
|
||||||
|
for _, diagnostic := range loadErr.Diagnostics() {
|
||||||
|
if diagnostic.Code == configkit.CodeComposeConflict {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
t.Fatalf("missing duplicate conflict: %+v", loadErr.Diagnostics())
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFinalIdentitiesAreCheckedAfterApplicationResolution(t *testing.T) {
|
||||||
|
for _, kind := range []string{"backends", "profiles", "prompts"} {
|
||||||
|
for _, namespace := range []string{"", "*"} {
|
||||||
|
t.Run(kind+"/"+namespace, func(t *testing.T) {
|
||||||
|
definition := configurationDefinition(&loaded{})
|
||||||
|
definition.Resolve = func(config *document, resolution *configkit.Resolution) error {
|
||||||
|
path := configkit.Keys(kind)
|
||||||
|
if namespace == "" {
|
||||||
|
switch kind {
|
||||||
|
case "backends":
|
||||||
|
config.Backends = []backendConfig{{ID: "same"}, {ID: "same"}}
|
||||||
|
case "profiles":
|
||||||
|
config.Profiles = []profileConfig{{ID: "same"}, {ID: "same"}}
|
||||||
|
case "prompts":
|
||||||
|
config.Prompts = []promptConfig{{ID: "same"}, {ID: "same"}}
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
collection := collectionConfig{}
|
||||||
|
switch kind {
|
||||||
|
case "backends":
|
||||||
|
collection.Backends = []backendConfig{{ID: "same"}, {ID: "same"}}
|
||||||
|
case "profiles":
|
||||||
|
collection.Profiles = []profileConfig{{ID: "same"}, {ID: "same"}}
|
||||||
|
case "prompts":
|
||||||
|
collection.Prompts = []promptConfig{{ID: "same"}, {ID: "same"}}
|
||||||
|
}
|
||||||
|
config.Collections = map[string]collectionConfig{namespace: collection}
|
||||||
|
path = configkit.Keys("collections", namespace, kind)
|
||||||
|
}
|
||||||
|
resolution.RecordNormalization(path, "supply resolved records")
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
input := configkit.Input{Source: configkit.NoSource()}
|
||||||
|
if namespace != "" {
|
||||||
|
input = mapping("existing collection", map[string]any{"collections": map[string]any{
|
||||||
|
namespace: map[string]any{kind: []any{}},
|
||||||
|
}})
|
||||||
|
}
|
||||||
|
_, err := configkit.LoadLayered(input, configkit.LayeredOptions[document]{Definition: definition})
|
||||||
|
var loadErr *configkit.LoadError
|
||||||
|
if !errors.As(err, &loadErr) {
|
||||||
|
t.Fatalf("load error = %v, want a final identity diagnostic", err)
|
||||||
|
}
|
||||||
|
for _, diagnostic := range loadErr.Diagnostics() {
|
||||||
|
if diagnostic.Code == configkit.CodeSequenceConflict {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
t.Fatalf("missing final identity conflict: %+v", loadErr.Diagnostics())
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestIdentifiedResourceLayerOperations(t *testing.T) {
|
||||||
|
base := mapping("base profiles", map[string]any{"profiles": []any{
|
||||||
|
map[string]any{"id": "first", "model": "original", "service_tier": "standard"},
|
||||||
|
map[string]any{"id": "second", "model": "retained"},
|
||||||
|
}})
|
||||||
|
for _, test := range []struct {
|
||||||
|
name string
|
||||||
|
mode string
|
||||||
|
records []any
|
||||||
|
models map[string]string
|
||||||
|
}{
|
||||||
|
{name: "whole record upsert", records: []any{map[string]any{"id": "first", "model": "updated"}}, models: map[string]string{"first": "updated", "second": "retained"}},
|
||||||
|
{name: "empty upsert", records: []any{}, models: map[string]string{"first": "original", "second": "retained"}},
|
||||||
|
{name: "append", mode: "append", records: []any{map[string]any{"id": "third", "model": "added"}}, models: map[string]string{"first": "original", "second": "retained", "third": "added"}},
|
||||||
|
{name: "replace", mode: "replace", records: []any{map[string]any{"id": "third", "model": "replacement"}}, models: map[string]string{"third": "replacement"}},
|
||||||
|
{name: "clear", mode: "replace", records: []any{}, models: map[string]string{}},
|
||||||
|
} {
|
||||||
|
t.Run(test.name, func(t *testing.T) {
|
||||||
|
values := map[string]any{"profiles": test.records}
|
||||||
|
if test.mode != "" {
|
||||||
|
values["config"] = map[string]any{"sequences": []any{map[string]any{
|
||||||
|
"destination": []any{"profiles"}, "mode": test.mode,
|
||||||
|
}}}
|
||||||
|
}
|
||||||
|
state, err := load(mapping("overlay profiles", values), []configkit.Underlay{{Inputs: []configkit.Input{base}}})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
profiles := indexedProfiles(&state.result.Config)
|
||||||
|
if len(profiles) != len(test.models) {
|
||||||
|
t.Fatalf("profiles = %+v, want IDs and models %+v", profiles, test.models)
|
||||||
|
}
|
||||||
|
for id, model := range test.models {
|
||||||
|
profile, ok := profiles[id]
|
||||||
|
if !ok || profile.Model == nil || *profile.Model != model {
|
||||||
|
t.Fatalf("profile %q = %+v, want model %q", id, profile, model)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if test.name == "whole record upsert" && profiles["first"].ServiceTier != nil {
|
||||||
|
t.Fatalf("upsert retained a displaced field: %+v", profiles["first"])
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestIdentifiedResourceLayersRejectDisplacedParentAndDuplicateAppend(t *testing.T) {
|
||||||
|
base := mapping("base", map[string]any{"profiles": []any{
|
||||||
|
map[string]any{"id": "shared", "model": "original"},
|
||||||
|
}})
|
||||||
|
for _, test := range []struct {
|
||||||
|
name string
|
||||||
|
values map[string]any
|
||||||
|
code configkit.Code
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "self extension cannot recover displaced record",
|
||||||
|
values: map[string]any{"profiles": []any{
|
||||||
|
map[string]any{"id": "shared", "extends": map[string]any{"id": "shared"}},
|
||||||
|
}},
|
||||||
|
code: configkit.CodeInheritanceCycle,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "append cannot duplicate an identity",
|
||||||
|
values: map[string]any{
|
||||||
|
"config": map[string]any{"sequences": []any{map[string]any{"destination": []any{"profiles"}, "mode": "append"}}},
|
||||||
|
"profiles": []any{map[string]any{"id": "shared", "model": "other"}},
|
||||||
|
},
|
||||||
|
code: configkit.CodeSequenceConflict,
|
||||||
|
},
|
||||||
|
} {
|
||||||
|
t.Run(test.name, func(t *testing.T) {
|
||||||
|
_, err := load(mapping("overlay", test.values), []configkit.Underlay{{Inputs: []configkit.Input{base}}})
|
||||||
|
var loadErr *configkit.LoadError
|
||||||
|
if !errors.As(err, &loadErr) {
|
||||||
|
t.Fatalf("load error = %v, want structured diagnostic", err)
|
||||||
|
}
|
||||||
|
for _, diagnostic := range loadErr.Diagnostics() {
|
||||||
|
if diagnostic.Code == test.code {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
t.Fatalf("missing %s diagnostic: %+v", test.code, loadErr.Diagnostics())
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLoadChecksOptionalConfigurationVersion(t *testing.T) {
|
||||||
|
for _, test := range []struct {
|
||||||
|
name string
|
||||||
|
version any
|
||||||
|
include bool
|
||||||
|
valid bool
|
||||||
|
}{
|
||||||
|
{name: "string two", version: "2", include: true, valid: true},
|
||||||
|
{name: "integer two", version: int64(2), include: true, valid: true},
|
||||||
|
{name: "omitted", valid: true},
|
||||||
|
{name: "explicit null", include: true},
|
||||||
|
{name: "unsupported string", version: "1", include: true},
|
||||||
|
} {
|
||||||
|
t.Run(test.name, func(t *testing.T) {
|
||||||
|
values := map[string]any{}
|
||||||
|
if test.include {
|
||||||
|
values["version"] = test.version
|
||||||
|
}
|
||||||
|
loaded, err := load(mapping("main", values), nil)
|
||||||
|
if test.valid {
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("load accepted version: %v", err)
|
||||||
|
}
|
||||||
|
if test.include && (loaded.result.Config.Version == nil || *loaded.result.Config.Version != "2") {
|
||||||
|
t.Fatalf("typed version = %v, want 2", loaded.result.Config.Version)
|
||||||
|
}
|
||||||
|
if !test.include && loaded.result.Config.Version != nil {
|
||||||
|
t.Fatalf("omitted version = %q, want nil", *loaded.result.Config.Version)
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
var loadErr *configkit.LoadError
|
||||||
|
if err == nil || !errors.As(err, &loadErr) {
|
||||||
|
t.Fatalf("load error = %v, want ConfigKit load error", err)
|
||||||
|
}
|
||||||
|
found := false
|
||||||
|
for _, diagnostic := range loadErr.Diagnostics() {
|
||||||
|
if diagnostic.Path.String() == "/version" && diagnostic.Message == "unsupported configuration specification version" {
|
||||||
|
found = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if !found {
|
||||||
|
t.Fatalf("load diagnostics = %+v, want safe version diagnostic", loadErr.Diagnostics())
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLoadRejectsMalformedHeadersAndLegacyResourceMappings(t *testing.T) {
|
||||||
|
for name, values := range map[string]map[string]any{
|
||||||
|
"boolean header": {"version": true},
|
||||||
|
"fractional header": {"version": 2.5},
|
||||||
|
"sequence header": {"version": []any{2}},
|
||||||
|
"backend mapping": {"backends": map[string]any{"local": map[string]any{"endpoint": "https://example.invalid/v1"}}},
|
||||||
|
"profile mapping": {"profiles": map[string]any{"local": map[string]any{}}},
|
||||||
|
"prompt mapping": {"prompts": map[string]any{"local": map[string]any{}}},
|
||||||
|
} {
|
||||||
|
t.Run(name, func(t *testing.T) {
|
||||||
|
_, err := load(mapping(name, values), nil)
|
||||||
|
var loadErr *configkit.LoadError
|
||||||
|
if !errors.As(err, &loadErr) || len(loadErr.Diagnostics()) == 0 {
|
||||||
|
t.Fatalf("load error = %v, want structured rejection", err)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNestedConfigRemainsApplicationData(t *testing.T) {
|
||||||
|
state, err := load(mapping("nested config", map[string]any{
|
||||||
|
"config": map[string]any{},
|
||||||
|
"profiles": []any{map[string]any{"id": "example", "extra_params": map[string]any{
|
||||||
|
"config": map[string]any{"imports": "provider data"},
|
||||||
|
}}},
|
||||||
|
}), nil)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
profile, err := state.GetProfile(context.Background(), "example")
|
||||||
|
if err != nil || profile.ResolvedTarget.ExtraParams["config"].(map[string]any)["imports"] != "provider data" {
|
||||||
|
t.Fatalf("nested application data = %+v, %v", profile, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLoadConsumesAcceptedUnderlayVersionAndValidatesHeaderlessPayload(t *testing.T) {
|
||||||
|
underlay := mapping("declared underlay", map[string]any{
|
||||||
|
"version": int64(2),
|
||||||
|
})
|
||||||
|
loaded, err := load(mapping("headerless main", map[string]any{}), []configkit.Underlay{{Inputs: []configkit.Input{underlay}}})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("load accepted non-main declaration: %v", err)
|
||||||
|
}
|
||||||
|
if loaded.result.Config.Version != nil {
|
||||||
|
t.Fatalf("consumed non-main declaration remained in effective payload: %q", *loaded.result.Config.Version)
|
||||||
|
}
|
||||||
|
|
||||||
|
invalidFragment := mapping("headerless prompt fragment", map[string]any{
|
||||||
|
"prompts": []any{map[string]any{"id": "incomplete", "description": "still validated"}},
|
||||||
|
})
|
||||||
|
if _, err := load(configkit.Input{Source: configkit.NoSource()}, []configkit.Underlay{{Inputs: []configkit.Input{invalidFragment}}}); err == nil || !strings.Contains(err.Error(), "at least one message is required") {
|
||||||
|
t.Fatalf("headerless fragment validation error = %v, want final prompt validation", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLoadComposesLiteralKeysAndEffectivePresence(t *testing.T) {
|
||||||
|
base := mapping("defaults", map[string]any{
|
||||||
|
"version": int64(2),
|
||||||
|
"backends": []any{map[string]any{"id": "local.v1", "endpoint": "http://localhost:8080/v1", "concurrency_limit": 2}},
|
||||||
|
"collections": map[string]any{"base": map[string]any{
|
||||||
|
"release_version": "",
|
||||||
|
"backends": []any{map[string]any{"id": "local.v1", "endpoint": "http://localhost:8080/v1", "concurrency_limit": 3}},
|
||||||
|
"profiles": []any{
|
||||||
|
map[string]any{"id": "one", "backend": "local.v1", "temperature": 0.8, "top_p": 0.9, "api_key_required": true,
|
||||||
|
"extra_params": map[string]any{"provider": map[string]any{"first": 1, "second": 2}}},
|
||||||
|
map[string]any{"id": "child.v1", "extends": map[string]any{"id": "one"}},
|
||||||
|
map[string]any{"id": "namespaced", "backend": "base/local.v1", "model": "collection-model"},
|
||||||
|
},
|
||||||
|
}, "invoice": map[string]any{
|
||||||
|
"release_version": "r7",
|
||||||
|
"prompts": []any{
|
||||||
|
map[string]any{"id": "summary",
|
||||||
|
"messages": []any{map[string]any{"role": "user", "content": "Summarize."}},
|
||||||
|
"output": map[string]any{"format": "text", "validation_mode": "basic"},
|
||||||
|
},
|
||||||
|
map[string]any{"id": "version",
|
||||||
|
"messages": []any{map[string]any{"role": "user", "content": "Nested ID."}},
|
||||||
|
"output": map[string]any{"format": "text", "validation_mode": "basic"},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
}},
|
||||||
|
})
|
||||||
|
overlay := mapping("operator", map[string]any{
|
||||||
|
"backends": []any{map[string]any{"id": "local.v1", "endpoint": "http://localhost:8080/v1", "concurrency_limit": 2, "queue_capacity": 0}},
|
||||||
|
"collections": map[string]any{"base": map[string]any{"profiles": []any{map[string]any{"id": "child.v1", "extends": map[string]any{"id": "one"},
|
||||||
|
"temperature": 0, "top_p": nil, "api_key_required": false,
|
||||||
|
"extra_params": map[string]any{"provider": map[string]any{"second": 3}},
|
||||||
|
}}}},
|
||||||
|
})
|
||||||
|
loaded, err := load(mapping("main", map[string]any{"version": "2"}), []configkit.Underlay{
|
||||||
|
{Inputs: []configkit.Input{base}}, {Inputs: []configkit.Input{overlay}},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
var loadErr *configkit.LoadError
|
||||||
|
if errors.As(err, &loadErr) {
|
||||||
|
t.Fatalf("load: %v; diagnostics: %+v", err, loadErr.Diagnostics())
|
||||||
|
}
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
profile := loaded.result.Config.Collections["base"].Profiles[1]
|
||||||
if profile.Temperature == nil || *profile.Temperature != 0 || profile.TopP != nil || profile.APIKeyRequired == nil || *profile.APIKeyRequired {
|
if profile.Temperature == nil || *profile.Temperature != 0 || profile.TopP != nil || profile.APIKeyRequired == nil || *profile.APIKeyRequired {
|
||||||
t.Fatalf("effective values were not retained: %+v", profile)
|
t.Fatalf("effective values were not retained: %+v", profile)
|
||||||
}
|
}
|
||||||
if loaded.profiles["child.v1"]["temperature"] != fieldValue || loaded.profiles["child.v1"]["top_p"] != fieldNull || loaded.profiles["child.v1"]["api_key_required"] != fieldValue {
|
if loaded.profiles["base/child.v1"]["temperature"] != fieldValue || loaded.profiles["base/child.v1"]["top_p"] != fieldNull || loaded.profiles["base/child.v1"]["api_key_required"] != fieldValue {
|
||||||
t.Fatalf("effective presence was lost: %+v", loaded.profiles["child.v1"])
|
t.Fatalf("effective presence was lost: %+v", loaded.profiles["base/child.v1"])
|
||||||
}
|
}
|
||||||
provider := profile.ExtraParams["provider"].(map[string]any)
|
provider := profile.ExtraParams["provider"].(map[string]any)
|
||||||
if provider["first"] != int64(1) || provider["second"] != int64(3) {
|
if provider["first"] != int64(1) || provider["second"] != int64(3) {
|
||||||
t.Fatalf("recursive overlay failed: %+v", provider)
|
t.Fatalf("recursive overlay failed: %+v", provider)
|
||||||
}
|
}
|
||||||
backend := loaded.result.Config.Backends["local.v1"]
|
backend := loaded.result.Config.Backends[0]
|
||||||
if backend.QueueCapacity == nil || *backend.QueueCapacity != 0 || loaded.backends["local.v1"]["queue_capacity"] != fieldValue {
|
if backend.QueueCapacity == nil || *backend.QueueCapacity != 0 || loaded.backends["local.v1"]["queue_capacity"] != fieldValue {
|
||||||
t.Fatalf("explicit zero queue capacity was lost: %+v", backend)
|
t.Fatalf("explicit zero queue capacity was lost: %+v", backend)
|
||||||
}
|
}
|
||||||
if loaded.result.Config.Prompts["invoice/summary"]["v1.0"].Messages[0].Content == nil {
|
if _, err := loaded.registry.GetBackend("base/local.v1"); err != nil {
|
||||||
t.Fatal("literal prompt ID and version were not decoded")
|
t.Fatalf("collection backend was not indexed by its full ID: %v", err)
|
||||||
|
}
|
||||||
|
collectionProfile, exists := loaded.indexedProfiles["base/namespaced"]
|
||||||
|
if !exists || collectionProfile.ID != "base/namespaced" || collectionProfile.ResolvedTarget == nil || collectionProfile.ResolvedTarget.BackendID != "base/local.v1" {
|
||||||
|
t.Fatalf("collection profile snapshot = %+v, exists %t", collectionProfile, exists)
|
||||||
|
}
|
||||||
|
if loaded.result.Config.Collections["invoice"].Prompts[0].Messages[0].Content == nil {
|
||||||
|
t.Fatal("literal prompt content was not decoded")
|
||||||
|
}
|
||||||
|
if loaded.result.Config.Version == nil || *loaded.result.Config.Version != "2" ||
|
||||||
|
loaded.result.Config.Collections["base"].ReleaseVersion == nil || *loaded.result.Config.Collections["base"].ReleaseVersion != "" ||
|
||||||
|
loaded.result.Config.Collections["invoice"].ReleaseVersion == nil || *loaded.result.Config.Collections["invoice"].ReleaseVersion != "r7" {
|
||||||
|
t.Fatalf("root or collection version metadata was not retained: %+v", loaded.result.Config)
|
||||||
|
}
|
||||||
|
if _, _, err := loaded.prompt("invoice/version"); err != nil {
|
||||||
|
t.Fatalf("resource named version was not indexed under its qualified identity: %v", err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestLoadRecordsBackendNormalizationAndNullDefault(t *testing.T) {
|
func TestLoadRejectsInvalidCollectionAndResourceKeys(t *testing.T) {
|
||||||
loaded, err := load(mapping("backend", map[string]any{"backends": map[string]any{
|
for _, test := range []struct {
|
||||||
"local": map[string]any{"endpoint": " HTTP://localhost:8080/v1 ", "api_key_env": " TOKEN_NAME ",
|
name string
|
||||||
|
values map[string]any
|
||||||
|
message string
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "namespace with separator",
|
||||||
|
values: map[string]any{"collections": map[string]any{"bad/name": map[string]any{}}},
|
||||||
|
message: "collection namespace must be nonblank and contain no slash",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "root resource with separator",
|
||||||
|
values: map[string]any{"backends": []any{
|
||||||
|
map[string]any{"id": "bad/name", "endpoint": "https://example.test/v1"},
|
||||||
|
}},
|
||||||
|
message: "backend ID must be a nonblank local key without a slash",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "collection resource with separator",
|
||||||
|
values: map[string]any{"collections": map[string]any{"good": map[string]any{
|
||||||
|
"prompts": []any{map[string]any{"id": "bad/name",
|
||||||
|
"messages": []any{map[string]any{"role": "user", "content": "Hello."}},
|
||||||
|
"output": map[string]any{"format": "text", "validation_mode": "basic"},
|
||||||
|
}},
|
||||||
|
}}},
|
||||||
|
message: "prompt ID must be a nonblank local key without a slash",
|
||||||
|
},
|
||||||
|
} {
|
||||||
|
t.Run(test.name, func(t *testing.T) {
|
||||||
|
_, err := load(mapping("invalid names", test.values), nil)
|
||||||
|
var loadErr *configkit.LoadError
|
||||||
|
if err == nil || !errors.As(err, &loadErr) {
|
||||||
|
t.Fatalf("load error = %v, want ConfigKit validation error", err)
|
||||||
|
}
|
||||||
|
for _, diagnostic := range loadErr.Diagnostics() {
|
||||||
|
if diagnostic.Message == test.message {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
t.Fatalf("load diagnostics = %+v, want message %q", loadErr.Diagnostics(), test.message)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLoadInterpretsBackendNormalizationAndNullDefault(t *testing.T) {
|
||||||
|
loaded, err := load(mapping("backend", map[string]any{"backends": []any{
|
||||||
|
map[string]any{"id": "local", "endpoint": " HTTP://localhost:8080/v1 ", "api_key_env": " TOKEN_NAME ",
|
||||||
"concurrency_limit": 2, "queue_capacity": nil},
|
"concurrency_limit": 2, "queue_capacity": nil},
|
||||||
}}), nil)
|
}}), nil)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
backend := loaded.result.Config.Backends["local"]
|
backend, err := loaded.GetBackend("local")
|
||||||
if backend.Endpoint == nil || *backend.Endpoint != "http://localhost:8080/v1" ||
|
if err != nil || backend.Endpoint != "http://localhost:8080/v1" ||
|
||||||
backend.APIKeyEnv == nil || *backend.APIKeyEnv != "TOKEN_NAME" ||
|
backend.APIKeyEnv != "TOKEN_NAME" || backend.QueueCapacity != 1024 {
|
||||||
backend.QueueCapacity == nil || *backend.QueueCapacity != 1024 {
|
|
||||||
t.Fatalf("backend normalization/default was not applied: %+v", backend)
|
t.Fatalf("backend normalization/default was not applied: %+v", backend)
|
||||||
}
|
}
|
||||||
|
composed := loaded.result.Config.Backends[0]
|
||||||
|
if composed.Endpoint == nil || *composed.Endpoint != " HTTP://localhost:8080/v1 " ||
|
||||||
|
composed.APIKeyEnv == nil || *composed.APIKeyEnv != " TOKEN_NAME " || composed.QueueCapacity != nil {
|
||||||
|
t.Fatalf("composed backend was changed: %+v", composed)
|
||||||
|
}
|
||||||
if loaded.backends["local"]["queue_capacity"] != fieldNull {
|
if loaded.backends["local"]["queue_capacity"] != fieldNull {
|
||||||
t.Fatalf("explicit null was not retained: %+v", loaded.backends["local"])
|
t.Fatalf("explicit null was not retained: %+v", loaded.backends["local"])
|
||||||
}
|
}
|
||||||
|
field, found := loaded.result.Metadata().Lookup(configkit.Keys("backends").Index(0).Key("endpoint"))
|
||||||
|
if !found || field.Origin.Operation == configkit.ChangeNormalization || len(field.Origin.Locations) == 0 {
|
||||||
|
t.Fatalf("endpoint origin was not preserved: %+v", field)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLoadBackendSmokeTestsOmissionAndNull(t *testing.T) {
|
||||||
|
for _, test := range []struct {
|
||||||
|
name string
|
||||||
|
smokeTests any
|
||||||
|
include bool
|
||||||
|
inherited bool
|
||||||
|
}{
|
||||||
|
{name: "omitted"},
|
||||||
|
{name: "null", smokeTests: nil, include: true, inherited: true},
|
||||||
|
} {
|
||||||
|
t.Run(test.name, func(t *testing.T) {
|
||||||
|
backend := map[string]any{"id": "local", "endpoint": "https://backend.example/v1"}
|
||||||
|
if test.include {
|
||||||
|
backend["smoke_tests"] = test.smokeTests
|
||||||
|
}
|
||||||
|
main := mapping("backend", map[string]any{
|
||||||
|
"backends": []any{backend},
|
||||||
|
})
|
||||||
|
var underlays []configkit.Underlay
|
||||||
|
if test.inherited {
|
||||||
|
underlays = []configkit.Underlay{{Inputs: []configkit.Input{mapping("defaults", map[string]any{
|
||||||
|
"backends": []any{map[string]any{"id": "local",
|
||||||
|
"endpoint": "https://backend.example/v1",
|
||||||
|
"smoke_tests": map[string]any{"default_profile": "inherited-profile"},
|
||||||
|
}},
|
||||||
|
})}}}
|
||||||
|
}
|
||||||
|
loaded, err := load(main, underlays)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if got := loaded.result.Config.Backends[0].SmokeTests; got != nil {
|
||||||
|
t.Fatalf("smoke_tests = %+v, want nil", got)
|
||||||
|
}
|
||||||
|
selected, err := loaded.registry.GetBackend("local")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if selected.SmokeTests != nil {
|
||||||
|
t.Fatalf("indexed smoke_tests = %+v, want nil", selected.SmokeTests)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLoadMergesBackendSmokeTestsAndRetainsFallbacks(t *testing.T) {
|
||||||
|
base := mapping("defaults", map[string]any{
|
||||||
|
"backends": []any{map[string]any{"id": "catalog",
|
||||||
|
"endpoint": "https://backend.example/v1",
|
||||||
|
"smoke_tests": map[string]any{
|
||||||
|
"default_profile": "catalog-profile",
|
||||||
|
"reachability": map[string]any{"endpoint": " https://probe.example/ready?check=1 "},
|
||||||
|
"authentication": map[string]any{
|
||||||
|
"kind": " OPENROUTER_KEY ",
|
||||||
|
"endpoint": "https://probe.example/key?scope=current",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
}},
|
||||||
|
})
|
||||||
|
overlay := mapping("operator", map[string]any{
|
||||||
|
"backends": []any{map[string]any{"id": "local", "extends": map[string]any{"id": "catalog"},
|
||||||
|
"smoke_tests": map[string]any{
|
||||||
|
"default_profile": "not-yet-listed",
|
||||||
|
"authentication": map[string]any{"kind": " NONE ", "endpoint": nil},
|
||||||
|
},
|
||||||
|
}},
|
||||||
|
})
|
||||||
|
loaded, err := load(configkit.Input{Source: configkit.NoSource()}, []configkit.Underlay{
|
||||||
|
{Inputs: []configkit.Input{base}},
|
||||||
|
{Inputs: []configkit.Input{overlay}},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("load effective diagnostic metadata: %v", err)
|
||||||
|
}
|
||||||
|
selected, err := loaded.registry.GetBackend("local")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
metadata := selected.SmokeTests
|
||||||
|
if selected.Endpoint != "https://backend.example/v1" {
|
||||||
|
t.Fatalf("effective backend endpoint = %q", selected.Endpoint)
|
||||||
|
}
|
||||||
|
if metadata == nil || metadata.DefaultProfile == nil || *metadata.DefaultProfile != "not-yet-listed" {
|
||||||
|
t.Fatalf("default profile overlay was not retained: %+v", metadata)
|
||||||
|
}
|
||||||
|
if metadata.Reachability == nil || metadata.Reachability.Endpoint == nil ||
|
||||||
|
*metadata.Reachability.Endpoint != "https://probe.example/ready?check=1" {
|
||||||
|
t.Fatalf("full reachability destination was not normalized: %+v", metadata.Reachability)
|
||||||
|
}
|
||||||
|
if metadata.Authentication == nil || metadata.Authentication.Kind == nil || *metadata.Authentication.Kind != "none" ||
|
||||||
|
metadata.Authentication.Endpoint != nil {
|
||||||
|
t.Fatalf("authentication overlay or null fallback was not retained: %+v", metadata.Authentication)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLoadRejectsInvalidFinalBackendSmokeTests(t *testing.T) {
|
||||||
|
for _, test := range []struct {
|
||||||
|
name string
|
||||||
|
data map[string]any
|
||||||
|
path string
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "blank default profile",
|
||||||
|
data: map[string]any{"default_profile": " \t "},
|
||||||
|
path: "/backends/0/smoke_tests/default_profile",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "authentication kind required",
|
||||||
|
data: map[string]any{"authentication": map[string]any{}},
|
||||||
|
path: "/backends/0/smoke_tests/authentication/kind",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "unknown authentication kind",
|
||||||
|
data: map[string]any{"authentication": map[string]any{"kind": "bearer"}},
|
||||||
|
path: "/backends/0/smoke_tests/authentication/kind",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "non-http reachability URL",
|
||||||
|
data: map[string]any{"reachability": map[string]any{"endpoint": "ftp://probe.example/ready"}},
|
||||||
|
path: "/backends/0/smoke_tests/reachability/endpoint",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "blank authentication URL",
|
||||||
|
data: map[string]any{"authentication": map[string]any{"kind": "none", "endpoint": " "}},
|
||||||
|
path: "/backends/0/smoke_tests/authentication/endpoint",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "relative authentication URL",
|
||||||
|
data: map[string]any{"authentication": map[string]any{"kind": "none", "endpoint": "/key"}},
|
||||||
|
path: "/backends/0/smoke_tests/authentication/endpoint",
|
||||||
|
},
|
||||||
|
} {
|
||||||
|
t.Run(test.name, func(t *testing.T) {
|
||||||
|
_, err := load(mapping("backend", map[string]any{
|
||||||
|
"backends": []any{map[string]any{"id": "local",
|
||||||
|
"endpoint": "https://backend.example/v1",
|
||||||
|
"smoke_tests": test.data,
|
||||||
|
}},
|
||||||
|
}), nil)
|
||||||
|
var loadError *configkit.LoadError
|
||||||
|
if !errors.As(err, &loadError) {
|
||||||
|
t.Fatalf("expected final-value validation error, got %v", err)
|
||||||
|
}
|
||||||
|
for _, diagnostic := range loadError.Diagnostics() {
|
||||||
|
if diagnostic.Path.String() == test.path {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
t.Fatalf("expected diagnostic at %s, got %+v", test.path, loadError.Diagnostics())
|
||||||
|
})
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestLoadDefaultsAbsentQueueCapacity(t *testing.T) {
|
func TestLoadDefaultsAbsentQueueCapacity(t *testing.T) {
|
||||||
loaded, err := load(mapping("backend", map[string]any{"backends": map[string]any{
|
underlay := mapping("defaults", map[string]any{"backends": []any{
|
||||||
"local": map[string]any{"endpoint": "http://localhost:8080/v1", "concurrency_limit": 1},
|
map[string]any{"id": "local", "endpoint": "http://localhost:8080/v1", "api_key_env": "OLD_KEY"},
|
||||||
|
}})
|
||||||
|
loaded, err := load(mapping("backend", map[string]any{"backends": []any{
|
||||||
|
map[string]any{"id": "local", "endpoint": "http://localhost:8080/v1", "concurrency_limit": 1},
|
||||||
|
}}), []configkit.Underlay{{Inputs: []configkit.Input{underlay}}})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
backend, err := loaded.GetBackend("local")
|
||||||
|
if err != nil || backend.APIKeyEnv != "" || backend.QueueCapacity != 1024 || loaded.result.Config.Backends[0].QueueCapacity != nil || loaded.backends["local"]["queue_capacity"] != fieldAbsent {
|
||||||
|
t.Fatalf("absent queue capacity did not receive its default: %+v", backend)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLoadCapturesProfilePresence(t *testing.T) {
|
||||||
|
loaded, err := load(mapping("profile", map[string]any{"profiles": []any{
|
||||||
|
map[string]any{"id": "local", "temperature": 0, "top_p": nil, "api_key_required": false},
|
||||||
}}), nil)
|
}}), nil)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
backend := loaded.result.Config.Backends["local"]
|
profile := loaded.result.Config.Profiles[0]
|
||||||
if backend.QueueCapacity == nil || *backend.QueueCapacity != 1024 || loaded.backends["local"]["queue_capacity"] != fieldAbsent {
|
if profile.Temperature == nil || *profile.Temperature != 0 || profile.TopP != nil || profile.APIKeyRequired == nil || *profile.APIKeyRequired {
|
||||||
t.Fatalf("absent queue capacity did not receive its default: %+v", backend)
|
t.Fatalf("profile values were not preserved: %+v", profile)
|
||||||
|
}
|
||||||
|
fields := loaded.profiles["local"]
|
||||||
|
if fields["temperature"] != fieldValue || fields["top_p"] != fieldNull || fields["api_key_required"] != fieldValue || fields["model"] != fieldAbsent {
|
||||||
|
t.Fatalf("profile presence was not preserved: %+v", fields)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestLoadRejectsStrictGroupConflict(t *testing.T) {
|
func TestLoadRejectsStrictGroupConflict(t *testing.T) {
|
||||||
_, err := load(configkit.Input{Source: configkit.NoSource()}, []configkit.Underlay{{Inputs: []configkit.Input{
|
_, err := load(configkit.Input{Source: configkit.NoSource()}, []configkit.Underlay{{Inputs: []configkit.Input{
|
||||||
mapping("first", map[string]any{"profiles": map[string]any{"shared": map[string]any{"model": "one"}}}),
|
mapping("first", map[string]any{"profiles": []any{map[string]any{"id": "shared", "model": "one"}}}),
|
||||||
mapping("second", map[string]any{"profiles": map[string]any{"shared": map[string]any{"model": "one"}}}),
|
mapping("second", map[string]any{"profiles": []any{map[string]any{"id": "shared", "model": "one"}}}),
|
||||||
}}})
|
}}})
|
||||||
var loadError *configkit.LoadError
|
var loadError *configkit.LoadError
|
||||||
if !errors.As(err, &loadError) {
|
if !errors.As(err, &loadError) {
|
||||||
@@ -104,32 +746,66 @@ func TestLoadRejectsStrictGroupConflict(t *testing.T) {
|
|||||||
|
|
||||||
func TestLoadValidatesOnlyFinalDomainValues(t *testing.T) {
|
func TestLoadValidatesOnlyFinalDomainValues(t *testing.T) {
|
||||||
underlay := mapping("defaults", map[string]any{
|
underlay := mapping("defaults", map[string]any{
|
||||||
"backends": map[string]any{"local": map[string]any{"endpoint": "not a URL"}},
|
"backends": []any{map[string]any{"id": "local", "endpoint": "not a URL"}},
|
||||||
"profiles": map[string]any{"partial": map[string]any{"backend": "local"}},
|
"profiles": []any{map[string]any{"id": "partial", "backend": "local"}},
|
||||||
})
|
})
|
||||||
main := mapping("operator", map[string]any{"backends": map[string]any{"local": map[string]any{"endpoint": "http://localhost:8080/v1"}}})
|
main := mapping("operator", map[string]any{"backends": []any{map[string]any{"id": "local", "endpoint": "http://localhost:8080/v1"}}})
|
||||||
loaded, err := load(main, []configkit.Underlay{{Inputs: []configkit.Input{underlay}}})
|
loaded, err := load(main, []configkit.Underlay{{Inputs: []configkit.Input{underlay}}})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("replaced lower-layer domain value should not fail: %v", err)
|
t.Fatalf("replaced lower-layer domain value should not fail: %v", err)
|
||||||
}
|
}
|
||||||
if loaded.result.Config.Profiles["partial"].Model != nil {
|
if loaded.result.Config.Profiles[0].Model != nil {
|
||||||
t.Fatal("unused partial profile unexpectedly gained a model")
|
t.Fatal("unused partial profile unexpectedly gained a model")
|
||||||
}
|
}
|
||||||
|
|
||||||
_, err = load(configkit.Input{Source: configkit.NoSource()}, []configkit.Underlay{{Inputs: []configkit.Input{
|
_, err = load(configkit.Input{Source: configkit.NoSource()}, []configkit.Underlay{{Inputs: []configkit.Input{
|
||||||
mapping("invalid", map[string]any{"backends": map[string]any{"unused": map[string]any{"endpoint": "not a URL"}}}),
|
mapping("invalid", map[string]any{"backends": []any{map[string]any{"id": "unused", "endpoint": "not a URL"}}}),
|
||||||
}}})
|
}}})
|
||||||
var loadError *configkit.LoadError
|
var loadError *configkit.LoadError
|
||||||
if !errors.As(err, &loadError) {
|
if !errors.As(err, &loadError) {
|
||||||
t.Fatalf("expected path-aware effective backend failure, got %v", err)
|
t.Fatalf("expected path-aware effective backend failure, got %v", err)
|
||||||
}
|
}
|
||||||
if diagnostics := loadError.Diagnostics(); len(diagnostics) != 1 || diagnostics[0].Path.String() != "/backends/unused/endpoint" {
|
if diagnostics := loadError.Diagnostics(); len(diagnostics) != 1 || diagnostics[0].Path.String() != "/backends/0/endpoint" {
|
||||||
t.Fatalf("expected endpoint diagnostic, got %+v", diagnostics)
|
t.Fatalf("expected endpoint diagnostic, got %+v", diagnostics)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestLoadValidatesOnlyFinalBackendSmokeTestValues(t *testing.T) {
|
||||||
|
underlay := mapping("defaults", map[string]any{
|
||||||
|
"backends": []any{map[string]any{"id": "local",
|
||||||
|
"endpoint": "https://backend.example/v1",
|
||||||
|
"smoke_tests": map[string]any{
|
||||||
|
"default_profile": " ",
|
||||||
|
"reachability": map[string]any{"endpoint": "ftp://invalid.example/"},
|
||||||
|
"authentication": map[string]any{"kind": "unsupported"},
|
||||||
|
},
|
||||||
|
}},
|
||||||
|
})
|
||||||
|
main := mapping("operator", map[string]any{
|
||||||
|
"backends": []any{map[string]any{"id": "local", "endpoint": "https://backend.example/v1",
|
||||||
|
"smoke_tests": map[string]any{
|
||||||
|
"default_profile": "dangling-profile",
|
||||||
|
"reachability": map[string]any{"endpoint": nil},
|
||||||
|
"authentication": map[string]any{"kind": "none"},
|
||||||
|
},
|
||||||
|
}},
|
||||||
|
})
|
||||||
|
loaded, err := load(main, []configkit.Underlay{{Inputs: []configkit.Input{underlay}}})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("replaced lower metadata should not fail: %v", err)
|
||||||
|
}
|
||||||
|
selected, err := loaded.registry.GetBackend("local")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if selected.SmokeTests == nil || selected.SmokeTests.DefaultProfile == nil ||
|
||||||
|
*selected.SmokeTests.DefaultProfile != "dangling-profile" {
|
||||||
|
t.Fatalf("final dangling default profile was not retained: %+v", selected.SmokeTests)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestLoadKeepsSyntaxErrorsFromLowerTiers(t *testing.T) {
|
func TestLoadKeepsSyntaxErrorsFromLowerTiers(t *testing.T) {
|
||||||
_, err := load(mapping("operator", map[string]any{"backends": map[string]any{"local": map[string]any{"endpoint": "http://localhost:8080"}}}),
|
_, err := load(mapping("operator", map[string]any{"backends": []any{map[string]any{"id": "local", "endpoint": "http://localhost:8080"}}}),
|
||||||
[]configkit.Underlay{{Inputs: []configkit.Input{{Source: configkit.Bytes("broken", []byte("backends: ["))}}}})
|
[]configkit.Underlay{{Inputs: []configkit.Input{{Source: configkit.Bytes("broken", []byte("backends: ["))}}}})
|
||||||
var loadError *configkit.LoadError
|
var loadError *configkit.LoadError
|
||||||
if !errors.As(err, &loadError) {
|
if !errors.As(err, &loadError) {
|
||||||
|
|||||||
@@ -8,16 +8,15 @@ import (
|
|||||||
"strings"
|
"strings"
|
||||||
"text/template"
|
"text/template"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/ConfigKit"
|
"go.maximumdirect.net/configkit"
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/domain"
|
"go.maximumdirect.net/promptkit/internal/domain"
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/filecatalog"
|
"go.maximumdirect.net/promptkit/internal/filecatalog"
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/prompt"
|
"go.maximumdirect.net/promptkit/internal/prompt"
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/promptdef"
|
"go.maximumdirect.net/promptkit/internal/promptdef"
|
||||||
)
|
)
|
||||||
|
|
||||||
var (
|
var (
|
||||||
errPromptNotFound = errors.New("prompt definition not found")
|
errPromptNotFound = errors.New("prompt definition not found")
|
||||||
errPromptAmbiguous = errors.New("prompt version is ambiguous")
|
|
||||||
)
|
)
|
||||||
|
|
||||||
type promptEntry struct {
|
type promptEntry struct {
|
||||||
@@ -29,64 +28,46 @@ type promptEntry struct {
|
|||||||
messages []*template.Template
|
messages []*template.Template
|
||||||
}
|
}
|
||||||
|
|
||||||
func resolvePrompts(prompts map[string]map[string]promptConfig, resolution *configkit.Resolution) {
|
func interpretPrompts(source []promptConfig) []promptConfig {
|
||||||
for _, id := range sortedKeys(prompts) {
|
if source == nil {
|
||||||
for _, version := range sortedKeys(prompts[id]) {
|
return nil
|
||||||
definition := prompts[id][version]
|
}
|
||||||
base := configkit.Keys("prompts", id, version)
|
prompts := append([]promptConfig{}, source...)
|
||||||
for _, field := range []struct {
|
for index := range prompts {
|
||||||
name string
|
definition := &prompts[index]
|
||||||
value **string
|
for _, value := range []**string{&definition.Description, &definition.SessionID} {
|
||||||
}{
|
if *value != nil {
|
||||||
{"description", &definition.Description},
|
normalized := strings.TrimSpace(**value)
|
||||||
{"session_id", &definition.SessionID},
|
*value = &normalized
|
||||||
} {
|
|
||||||
if *field.value != nil {
|
|
||||||
normalizeString(field.value, base.Key(field.name), resolution, strings.TrimSpace(**field.value))
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
inputsChanged := false
|
}
|
||||||
|
if definition.Inputs != nil {
|
||||||
|
definition.Inputs = append([]promptInputConfig{}, definition.Inputs...)
|
||||||
for index := range definition.Inputs {
|
for index := range definition.Inputs {
|
||||||
input := &definition.Inputs[index]
|
input := &definition.Inputs[index]
|
||||||
inputPath := base.Key("inputs").Index(index)
|
input.Name = strings.TrimSpace(input.Name)
|
||||||
normalizedName := strings.TrimSpace(input.Name)
|
for _, value := range []**string{&input.ContentType, &input.Description} {
|
||||||
if normalizedName != input.Name {
|
if *value != nil {
|
||||||
configkit.Normalize(resolution, inputPath.Key("name"), &input.Name, normalizedName, "normalize input metadata")
|
normalized := strings.TrimSpace(**value)
|
||||||
inputsChanged = true
|
*value = &normalized
|
||||||
}
|
|
||||||
for _, field := range []struct {
|
|
||||||
name string
|
|
||||||
value **string
|
|
||||||
}{
|
|
||||||
{"content_type", &input.ContentType},
|
|
||||||
{"description", &input.Description},
|
|
||||||
} {
|
|
||||||
if *field.value != nil {
|
|
||||||
normalized := strings.TrimSpace(**field.value)
|
|
||||||
if normalized != **field.value {
|
|
||||||
configkit.Normalize(resolution, inputPath.Key(field.name), field.value, &normalized, "normalize input metadata")
|
|
||||||
inputsChanged = true
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
if inputsChanged {
|
}
|
||||||
resolution.Record(base.Key("inputs"), configkit.ChangeNormalization, "normalize input metadata")
|
if definition.Output != nil {
|
||||||
|
output := *definition.Output
|
||||||
|
definition.Output = &output
|
||||||
|
if output.SchemaPath != nil {
|
||||||
|
normalized := strings.TrimSpace(*output.SchemaPath)
|
||||||
|
output.SchemaPath = &normalized
|
||||||
}
|
}
|
||||||
// Normalize message metadata on execution-owned copies below. ConfigKit
|
|
||||||
// records sequence mutations as whole-value replacements, which would
|
|
||||||
// discard the effective source contexts of unchanged content_file fields.
|
|
||||||
if definition.Output != nil && definition.Output.SchemaPath != nil {
|
|
||||||
normalizeString(&definition.Output.SchemaPath, base.Key("output").Key("schema_path"), resolution, strings.TrimSpace(*definition.Output.SchemaPath))
|
|
||||||
}
|
|
||||||
prompts[id][version] = definition
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
return prompts
|
||||||
}
|
}
|
||||||
|
|
||||||
func (state *loaded) materializePrompts() error {
|
func (state *loaded) materializePrompts() error {
|
||||||
state.prompts = make(map[string]map[string]*promptEntry, len(state.result.Config.Prompts))
|
state.prompts = make(map[string]*promptEntry)
|
||||||
state.ambiguous = make(map[string]bool)
|
|
||||||
var metadata *configkit.Metadata
|
var metadata *configkit.Metadata
|
||||||
lookupOrigin := func(path configkit.Path) (configkit.FieldInfo, bool) {
|
lookupOrigin := func(path configkit.Path) (configkit.FieldInfo, bool) {
|
||||||
if metadata == nil {
|
if metadata == nil {
|
||||||
@@ -95,36 +76,28 @@ func (state *loaded) materializePrompts() error {
|
|||||||
}
|
}
|
||||||
return metadata.Lookup(path)
|
return metadata.Lookup(path)
|
||||||
}
|
}
|
||||||
for _, id := range sortedKeys(state.result.Config.Prompts) {
|
for _, resources := range resourceSets(&state.interpreted) {
|
||||||
if strings.TrimSpace(id) == "" {
|
for index, raw := range resources.prompts {
|
||||||
return fmt.Errorf("%s: prompt ID must not be blank", configkit.Keys("prompts", id))
|
promptBase := resources.bases.prompts.Index(index)
|
||||||
}
|
if strings.TrimSpace(raw.ID) == "" {
|
||||||
versions := state.result.Config.Prompts[id]
|
return fmt.Errorf("%s: prompt ID must not be blank", promptBase)
|
||||||
if versions == nil {
|
|
||||||
return fmt.Errorf("%s: prompt collection must be a mapping", configkit.Keys("prompts", id))
|
|
||||||
}
|
|
||||||
state.prompts[id] = make(map[string]*promptEntry, len(versions))
|
|
||||||
state.ambiguous[id] = len(versions) > 1
|
|
||||||
for _, version := range sortedKeys(versions) {
|
|
||||||
if strings.TrimSpace(version) == "" {
|
|
||||||
return fmt.Errorf("%s: prompt version must not be blank", configkit.Keys("prompts", id, version))
|
|
||||||
}
|
}
|
||||||
entry, err := state.materializePrompt(id, version, versions[version], lookupOrigin)
|
fullID := indexedResourceID(resources.namespace, raw.ID)
|
||||||
|
entry, err := state.materializePrompt(fullID, raw, promptBase, lookupOrigin)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
state.prompts[id][version] = entry
|
state.prompts[fullID] = entry
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (state *loaded) materializePrompt(id, version string, raw promptConfig, lookupOrigin func(configkit.Path) (configkit.FieldInfo, bool)) (*promptEntry, error) {
|
func (state *loaded) materializePrompt(id string, raw promptConfig, base configkit.Path, lookupOrigin func(configkit.Path) (configkit.FieldInfo, bool)) (*promptEntry, error) {
|
||||||
base := configkit.Keys("prompts", id, version)
|
|
||||||
if len(raw.Messages) == 0 {
|
if len(raw.Messages) == 0 {
|
||||||
return nil, fmt.Errorf("%s: at least one message is required", base.Key("messages"))
|
return nil, fmt.Errorf("%s: at least one message is required", base.Key("messages"))
|
||||||
}
|
}
|
||||||
definition := domain.PromptDefinition{ID: id, Version: version}
|
definition := domain.PromptDefinition{ID: id}
|
||||||
if raw.DefaultProfile != nil {
|
if raw.DefaultProfile != nil {
|
||||||
if strings.TrimSpace(*raw.DefaultProfile) == "" {
|
if strings.TrimSpace(*raw.DefaultProfile) == "" {
|
||||||
return nil, fmt.Errorf("%s: default profile must not be blank", base.Key("default_profile"))
|
return nil, fmt.Errorf("%s: default profile must not be blank", base.Key("default_profile"))
|
||||||
@@ -163,7 +136,7 @@ func (state *loaded) materializePrompt(id, version string, raw promptConfig, loo
|
|||||||
definition.Inputs = append(definition.Inputs, domain.PromptInput{
|
definition.Inputs = append(definition.Inputs, domain.PromptInput{
|
||||||
Name: input.Name, Required: input.Required, ContentType: contentType, Description: description,
|
Name: input.Name, Required: input.Required, ContentType: contentType, Description: description,
|
||||||
})
|
})
|
||||||
presence := state.promptMetadata[id][version][index]
|
presence := state.promptMetadata[id][index]
|
||||||
metadata := prompt.InputMetadata{Name: input.Name, Required: input.Required}
|
metadata := prompt.InputMetadata{Name: input.Name, Required: input.Required}
|
||||||
if presence.contentType == fieldValue {
|
if presence.contentType == fieldValue {
|
||||||
metadata.ContentType = stringPointer(contentType)
|
metadata.ContentType = stringPointer(contentType)
|
||||||
@@ -253,7 +226,7 @@ func (state *loaded) materializePrompt(id, version string, raw promptConfig, loo
|
|||||||
entry.definition = definition
|
entry.definition = definition
|
||||||
entry.hash = hash
|
entry.hash = hash
|
||||||
entry.inspection = domain.PromptInspection{
|
entry.inspection = domain.PromptInspection{
|
||||||
PromptID: id, PromptVersion: version, PromptHash: hash,
|
PromptID: id, PromptHash: hash,
|
||||||
DefaultProfileID: definition.DefaultProfile, Inputs: append([]domain.PromptInput(nil), definition.Inputs...),
|
DefaultProfileID: definition.DefaultProfile, Inputs: append([]domain.PromptInput(nil), definition.Inputs...),
|
||||||
OutputContract: contract,
|
OutputContract: contract,
|
||||||
}
|
}
|
||||||
@@ -265,6 +238,13 @@ func stringPointer(value string) *string {
|
|||||||
return ©
|
return ©
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func stringPointerValue(value *string) *string {
|
||||||
|
if value == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return stringPointer(*value)
|
||||||
|
}
|
||||||
|
|
||||||
func (state *loaded) readContent(fieldPath configkit.Path, name string, lookupOrigin func(configkit.Path) (configkit.FieldInfo, bool)) (string, error) {
|
func (state *loaded) readContent(fieldPath configkit.Path, name string, lookupOrigin func(configkit.Path) (configkit.FieldInfo, bool)) (string, error) {
|
||||||
if strings.TrimSpace(name) == "" {
|
if strings.TrimSpace(name) == "" {
|
||||||
return "", fmt.Errorf("%s: content_file path must not be blank", fieldPath)
|
return "", fmt.Errorf("%s: content_file path must not be blank", fieldPath)
|
||||||
@@ -297,20 +277,11 @@ func (state *loaded) readContent(fieldPath configkit.Path, name string, lookupOr
|
|||||||
return string(content), nil
|
return string(content), nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (state *loaded) lookupPromptEntry(id, version string) (*promptEntry, error) {
|
func (state *loaded) lookupPromptEntry(id string) (*promptEntry, error) {
|
||||||
if state == nil || strings.TrimSpace(id) == "" || (version != "" && strings.TrimSpace(version) == "") {
|
if state == nil || strings.TrimSpace(id) == "" {
|
||||||
return nil, errPromptNotFound
|
return nil, errPromptNotFound
|
||||||
}
|
}
|
||||||
versions := state.prompts[id]
|
entry := state.prompts[id]
|
||||||
if version == "" {
|
|
||||||
if state.ambiguous[id] {
|
|
||||||
return nil, errPromptAmbiguous
|
|
||||||
}
|
|
||||||
for selected := range versions {
|
|
||||||
version = selected
|
|
||||||
}
|
|
||||||
}
|
|
||||||
entry := versions[version]
|
|
||||||
if entry == nil {
|
if entry == nil {
|
||||||
return nil, errPromptNotFound
|
return nil, errPromptNotFound
|
||||||
}
|
}
|
||||||
@@ -341,8 +312,8 @@ func promptLookupError(err error) error {
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
func (state *loaded) prompt(id, version string) (*domain.PromptDefinition, domain.PromptInspection, error) {
|
func (state *loaded) prompt(id string) (*domain.PromptDefinition, domain.PromptInspection, error) {
|
||||||
entry, err := state.lookupPromptEntry(id, version)
|
entry, err := state.lookupPromptEntry(id)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, domain.PromptInspection{}, err
|
return nil, domain.PromptInspection{}, err
|
||||||
}
|
}
|
||||||
@@ -350,12 +321,12 @@ func (state *loaded) prompt(id, version string) (*domain.PromptDefinition, domai
|
|||||||
}
|
}
|
||||||
|
|
||||||
// GetPromptSnapshot returns an independently owned captured definition and its
|
// GetPromptSnapshot returns an independently owned captured definition and its
|
||||||
// construction-time hash. Lookup retains literal ID and version keys.
|
// construction-time hash.
|
||||||
func (state *loaded) GetPromptSnapshot(ctx context.Context, id, version string) (*domain.PromptDefinition, string, error) {
|
func (state *loaded) GetPromptSnapshot(ctx context.Context, id string) (*domain.PromptDefinition, string, error) {
|
||||||
if err := ctx.Err(); err != nil {
|
if err := ctx.Err(); err != nil {
|
||||||
return nil, "", err
|
return nil, "", err
|
||||||
}
|
}
|
||||||
entry, err := state.lookupPromptEntry(id, version)
|
entry, err := state.lookupPromptEntry(id)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, "", promptLookupError(err)
|
return nil, "", promptLookupError(err)
|
||||||
}
|
}
|
||||||
@@ -364,11 +335,11 @@ func (state *loaded) GetPromptSnapshot(ctx context.Context, id, version string)
|
|||||||
|
|
||||||
// GetPromptInspection returns an independently owned inspection of one
|
// GetPromptInspection returns an independently owned inspection of one
|
||||||
// captured prompt without copying its execution templates.
|
// captured prompt without copying its execution templates.
|
||||||
func (state *loaded) GetPromptInspection(ctx context.Context, id, version string) (*domain.PromptInspection, error) {
|
func (state *loaded) GetPromptInspection(ctx context.Context, id string) (*domain.PromptInspection, error) {
|
||||||
if err := ctx.Err(); err != nil {
|
if err := ctx.Err(); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
entry, err := state.lookupPromptEntry(id, version)
|
entry, err := state.lookupPromptEntry(id)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, promptLookupError(err)
|
return nil, promptLookupError(err)
|
||||||
}
|
}
|
||||||
@@ -376,17 +347,17 @@ func (state *loaded) GetPromptInspection(ctx context.Context, id, version string
|
|||||||
}
|
}
|
||||||
|
|
||||||
// GetPromptDefinition implements the runner's prompt lookup boundary.
|
// GetPromptDefinition implements the runner's prompt lookup boundary.
|
||||||
func (state *loaded) GetPromptDefinition(ctx context.Context, id, version string) (*domain.PromptDefinition, error) {
|
func (state *loaded) GetPromptDefinition(ctx context.Context, id string) (*domain.PromptDefinition, error) {
|
||||||
definition, _, err := state.GetPromptSnapshot(ctx, id, version)
|
definition, _, err := state.GetPromptSnapshot(ctx, id)
|
||||||
return definition, err
|
return definition, err
|
||||||
}
|
}
|
||||||
|
|
||||||
// GetCompiledTemplates returns construction-time parses for one exact prompt.
|
// GetCompiledTemplates returns construction-time parses for one prompt ID.
|
||||||
func (state *loaded) GetCompiledTemplates(id, version string) (prompt.CompiledTemplates, bool) {
|
func (state *loaded) GetCompiledTemplates(id string) (prompt.CompiledTemplates, bool) {
|
||||||
if state == nil {
|
if state == nil {
|
||||||
return prompt.CompiledTemplates{}, false
|
return prompt.CompiledTemplates{}, false
|
||||||
}
|
}
|
||||||
entry := state.prompts[id][version]
|
entry := state.prompts[id]
|
||||||
if entry == nil {
|
if entry == nil {
|
||||||
return prompt.CompiledTemplates{}, false
|
return prompt.CompiledTemplates{}, false
|
||||||
}
|
}
|
||||||
@@ -394,13 +365,13 @@ func (state *loaded) GetCompiledTemplates(id, version string) (prompt.CompiledTe
|
|||||||
}
|
}
|
||||||
|
|
||||||
// GetRequirementSnapshot returns captured templates and input metadata for
|
// GetRequirementSnapshot returns captured templates and input metadata for
|
||||||
// one exact prompt identity. Returned metadata and slices are independently
|
// one prompt ID. Returned metadata and slices are independently
|
||||||
// owned; the compiled templates are shared immutable construction-time parses.
|
// owned; the compiled templates are shared immutable construction-time parses.
|
||||||
func (state *loaded) GetRequirementSnapshot(id, version string) (prompt.RequirementSnapshot, bool) {
|
func (state *loaded) GetRequirementSnapshot(id string) (prompt.RequirementSnapshot, bool) {
|
||||||
if state == nil {
|
if state == nil {
|
||||||
return prompt.RequirementSnapshot{}, false
|
return prompt.RequirementSnapshot{}, false
|
||||||
}
|
}
|
||||||
entry := state.prompts[id][version]
|
entry := state.prompts[id]
|
||||||
if entry == nil {
|
if entry == nil {
|
||||||
return prompt.RequirementSnapshot{}, false
|
return prompt.RequirementSnapshot{}, false
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -10,21 +10,24 @@ import (
|
|||||||
"testing"
|
"testing"
|
||||||
"testing/fstest"
|
"testing/fstest"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/ConfigKit"
|
"go.maximumdirect.net/configkit"
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/promptdef"
|
"go.maximumdirect.net/promptkit/internal/promptdef"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestLoadCapturesInheritedImportedContent(t *testing.T) {
|
func TestLoadCapturesInheritedImportedContent(t *testing.T) {
|
||||||
files := fstest.MapFS{
|
files := fstest.MapFS{
|
||||||
"app/main.yaml": {Data: []byte("configkit:\n imports:\n - path: ../catalog/base.yaml\nprompts:\n child:\n extends: base\n")},
|
"app/main.yaml": {Data: []byte("config:\n imports:\n - path: ../catalog/base.yaml\n required: true\ncollections:\n docs:\n prompts:\n - id: child\n extends: {id: base}\n other:\n prompts:\n - id: child\n messages:\n - role: user\n content_file: ./body.md\n output:\n format: text\n validation_mode: none\n")},
|
||||||
"catalog/base.yaml": {Data: []byte("prompts:\n base:\n v1:\n messages:\n - role: ' USER '\n cache_control:\n type: ' ephemeral '\n ttl: ' 1h '\n content_file: ./body.md\n output:\n format: text\n validation_mode: basic\n")},
|
"app/body.md": {Data: []byte("Replacement {{.name}}")},
|
||||||
"catalog/body.md": {Data: []byte("Captured {{.name}}")},
|
"catalog/base.yaml": {Data: []byte("collections:\n docs:\n release_version: r1\n prompts:\n - id: base\n description: ' description '\n session_id: ' session '\n inputs:\n - name: ' document '\n content_type: ' text/plain '\n description: ' document source '\n messages:\n - role: ' USER '\n cache_control:\n type: ' ephemeral '\n ttl: ' 1h '\n content_file: ./body.md\n output:\n format: text\n validation_mode: basic\n")},
|
||||||
|
"catalog/body.md": {Data: []byte("Captured {{.name}}")},
|
||||||
|
"other/definition.yaml": {Data: []byte("collections:\n other:\n prompts:\n - id: child\n messages:\n - role: user\n content_file: ./body.md\n output:\n format: text\n validation_mode: none\n")},
|
||||||
|
"other/body.md": {Data: []byte("Other collection {{.name}}")},
|
||||||
}
|
}
|
||||||
namespace := configkit.NewFilesystem("embedded", files)
|
namespace := configkit.NewFilesystem("embedded", files)
|
||||||
state, err := load(configkit.Input{
|
state, err := load(configkit.Input{
|
||||||
Source: namespace.File("app/main.yaml"), Imports: true,
|
Source: namespace.File("app/main.yaml"), Imports: true,
|
||||||
Filesystem: &configkit.FilesystemContext{FS: &namespace, Root: "."},
|
Filesystem: &configkit.FilesystemContext{FS: &namespace, Root: "."},
|
||||||
}, nil)
|
}, []configkit.Underlay{{Inputs: []configkit.Input{{Source: namespace.File("other/definition.yaml"), Filesystem: &configkit.FilesystemContext{FS: &namespace, Root: "."}}}}})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
var loadError *configkit.LoadError
|
var loadError *configkit.LoadError
|
||||||
if errors.As(err, &loadError) {
|
if errors.As(err, &loadError) {
|
||||||
@@ -32,18 +35,36 @@ func TestLoadCapturesInheritedImportedContent(t *testing.T) {
|
|||||||
}
|
}
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
definition, inspection, err := state.prompt("child", "")
|
definition, inspection, err := state.prompt("docs/child")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
if definition.Templates[0].Content != "Captured {{.name}}" || inspection.PromptHash == "" {
|
if definition.Templates[0].Content != "Captured {{.name}}" || inspection.PromptHash == "" {
|
||||||
t.Fatalf("inherited file content was not captured: %+v, %+v", definition, inspection)
|
t.Fatalf("inherited file content was not captured: %+v, %+v", definition, inspection)
|
||||||
}
|
}
|
||||||
|
if definition.Description != "description" || definition.SessionID != "session" || len(definition.Inputs) != 1 ||
|
||||||
|
definition.Inputs[0].Name != "document" || definition.Inputs[0].ContentType != "text/plain" || definition.Inputs[0].Description != "document source" {
|
||||||
|
t.Fatalf("inherited metadata was not interpreted: %+v", definition)
|
||||||
|
}
|
||||||
message := definition.Templates[0]
|
message := definition.Templates[0]
|
||||||
if message.Role != "user" || message.CacheControl == nil || message.CacheControl.Type != "ephemeral" || message.CacheControl.TTL != "1h" {
|
if message.Role != "user" || message.CacheControl == nil || message.CacheControl.Type != "ephemeral" || message.CacheControl.TTL != "1h" {
|
||||||
t.Fatalf("message metadata was not normalized: %+v", message)
|
t.Fatalf("message metadata was not normalized: %+v", message)
|
||||||
}
|
}
|
||||||
field, ok := state.result.Metadata().Lookup(configkit.Keys("prompts", "child", "v1", "messages").Index(0).Key("content_file"))
|
childIndex := -1
|
||||||
|
for index, item := range state.result.Config.Collections["docs"].Prompts {
|
||||||
|
if item.ID == "child" {
|
||||||
|
childIndex = index
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if childIndex < 0 {
|
||||||
|
t.Fatal("inherited prompt missing from effective list")
|
||||||
|
}
|
||||||
|
composed := state.result.Config.Collections["docs"].Prompts[childIndex]
|
||||||
|
if *composed.Description != " description " || *composed.SessionID != " session " || composed.Inputs[0].Name != " document " ||
|
||||||
|
*composed.Inputs[0].ContentType != " text/plain " || *composed.Inputs[0].Description != " document source " {
|
||||||
|
t.Fatalf("composed metadata was changed: %+v", composed)
|
||||||
|
}
|
||||||
|
field, ok := state.result.Metadata().Lookup(configkit.Keys("collections", "docs", "prompts").Index(childIndex).Key("messages").Index(0).Key("content_file"))
|
||||||
if !ok || len(field.Origin.Locations) != 1 {
|
if !ok || len(field.Origin.Locations) != 1 {
|
||||||
t.Fatalf("content origin was lost during normalization: %+v", field)
|
t.Fatalf("content origin was lost during normalization: %+v", field)
|
||||||
}
|
}
|
||||||
@@ -56,16 +77,43 @@ func TestLoadCapturesInheritedImportedContent(t *testing.T) {
|
|||||||
if originPath != "catalog/base.yaml" {
|
if originPath != "catalog/base.yaml" {
|
||||||
t.Fatalf("content origin = %q, want catalog/base.yaml", originPath)
|
t.Fatalf("content origin = %q, want catalog/base.yaml", originPath)
|
||||||
}
|
}
|
||||||
|
other, otherInspection, err := state.prompt("other/child")
|
||||||
|
if err != nil || other.Templates[0].Content != "Replacement {{.name}}" {
|
||||||
|
t.Fatalf("other collection did not retain its source context: %+v, %v", other, err)
|
||||||
|
}
|
||||||
files["catalog/body.md"].Data = []byte("Changed")
|
files["catalog/body.md"].Data = []byte("Changed")
|
||||||
again, againInspection, err := state.prompt("child", "v1")
|
files["app/body.md"].Data = []byte("Changed replacement")
|
||||||
|
files["other/body.md"].Data = []byte("Changed other collection")
|
||||||
|
again, againInspection, err := state.prompt("docs/child")
|
||||||
if err != nil || again.Templates[0].Content != "Captured {{.name}}" || againInspection.PromptHash != inspection.PromptHash {
|
if err != nil || again.Templates[0].Content != "Captured {{.name}}" || againInspection.PromptHash != inspection.PromptHash {
|
||||||
t.Fatalf("captured definition changed after source mutation: %+v, %+v, %v", again, againInspection, err)
|
t.Fatalf("captured definition changed after source mutation: %+v, %+v, %v", again, againInspection, err)
|
||||||
}
|
}
|
||||||
definition.Templates[0].Content = "caller mutation"
|
definition.Templates[0].Content = "caller mutation"
|
||||||
third, _, err := state.prompt("child", "v1")
|
third, _, err := state.prompt("docs/child")
|
||||||
if err != nil || third.Templates[0].Content != "Captured {{.name}}" {
|
if err != nil || third.Templates[0].Content != "Captured {{.name}}" {
|
||||||
t.Fatalf("caller mutation escaped into index: %+v, %v", third, err)
|
t.Fatalf("caller mutation escaped into index: %+v, %v", third, err)
|
||||||
}
|
}
|
||||||
|
otherAgain, otherAgainInspection, err := state.prompt("other/child")
|
||||||
|
if err != nil || otherAgain.Templates[0].Content != "Replacement {{.name}}" || otherAgainInspection.PromptHash != otherInspection.PromptHash {
|
||||||
|
t.Fatalf("other captured definition changed after source mutation: %+v, %+v, %v", otherAgain, otherAgainInspection, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLoadHeaderlessImportedItem(t *testing.T) {
|
||||||
|
files := fstest.MapFS{
|
||||||
|
"main.yaml": {Data: []byte("version: 2\nconfig:\n imports:\n - path: item.yaml\n destination: [prompts]\n placement: sequence-item\n required: true\n")},
|
||||||
|
"item.yaml": {Data: []byte("id: example\nmessages:\n - role: user\n content: hello\noutput:\n format: text\n validation_mode: basic\n")},
|
||||||
|
}
|
||||||
|
namespace := configkit.NewFilesystem("items", files)
|
||||||
|
state, err := load(configkit.Input{Source: namespace.File("main.yaml"), Imports: true,
|
||||||
|
Filesystem: &configkit.FilesystemContext{FS: &namespace, Root: "."}}, nil)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
definition, _, err := state.prompt("example")
|
||||||
|
if err != nil || definition.Templates[0].Content != "hello" {
|
||||||
|
t.Fatalf("headerless item = %+v, %v", definition, err)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestLoadUsesExplicitMappingContextAndClosesContent(t *testing.T) {
|
func TestLoadUsesExplicitMappingContextAndClosesContent(t *testing.T) {
|
||||||
@@ -81,12 +129,12 @@ func TestLoadUsesExplicitMappingContextAndClosesContent(t *testing.T) {
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
definition, _, err := state.prompt("example", "v1")
|
definition, _, err := state.prompt("example")
|
||||||
if err != nil || definition.Templates[0].Content != "From mapping" || filesystem.contentOpened != 1 || filesystem.contentClosed != 1 {
|
if err != nil || definition.Templates[0].Content != "From mapping" || filesystem.contentOpened != 1 || filesystem.contentClosed != 1 {
|
||||||
t.Fatalf("mapping context or handle ownership failed: %+v, opens=%d closes=%d, %v", definition, filesystem.contentOpened, filesystem.contentClosed, err)
|
t.Fatalf("mapping context or handle ownership failed: %+v, opens=%d closes=%d, %v", definition, filesystem.contentOpened, filesystem.contentClosed, err)
|
||||||
}
|
}
|
||||||
_, err = load(mapping("contextless", promptWithFile("body.md")), nil)
|
_, err = load(mapping("contextless", promptWithFile("body.md")), nil)
|
||||||
if err == nil || !strings.Contains(err.Error(), "/prompts/example/v1/messages/0/content_file") {
|
if err == nil || !strings.Contains(err.Error(), "/prompts/0/messages/0/content_file") {
|
||||||
t.Fatalf("expected semantic path for contextless resource, got %v", err)
|
t.Fatalf("expected semantic path for contextless resource, got %v", err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -95,7 +143,7 @@ func TestLoadCapturesNativeContentFile(t *testing.T) {
|
|||||||
root := t.TempDir()
|
root := t.TempDir()
|
||||||
definitionPath := filepath.Join(root, "definition.yaml")
|
definitionPath := filepath.Join(root, "definition.yaml")
|
||||||
contentPath := filepath.Join(root, "body.md")
|
contentPath := filepath.Join(root, "body.md")
|
||||||
if err := os.WriteFile(definitionPath, []byte("prompts:\n example:\n v1:\n messages:\n - role: user\n content_file: body.md\n output:\n format: text\n validation_mode: basic\n"), 0o600); err != nil {
|
if err := os.WriteFile(definitionPath, []byte("prompts:\n - id: example\n messages:\n - role: user\n content_file: body.md\n output:\n format: text\n validation_mode: basic\n"), 0o600); err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
if err := os.WriteFile(contentPath, []byte("Native body"), 0o600); err != nil {
|
if err := os.WriteFile(contentPath, []byte("Native body"), 0o600); err != nil {
|
||||||
@@ -108,32 +156,20 @@ func TestLoadCapturesNativeContentFile(t *testing.T) {
|
|||||||
if err := os.WriteFile(contentPath, []byte("Modified"), 0o600); err != nil {
|
if err := os.WriteFile(contentPath, []byte("Modified"), 0o600); err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
definition, _, err := state.prompt("example", "v1")
|
definition, _, err := state.prompt("example")
|
||||||
if err != nil || definition.Templates[0].Content != "Native body" {
|
if err != nil || definition.Templates[0].Content != "Native body" {
|
||||||
t.Fatalf("native content was not captured: %+v, %v", definition, err)
|
t.Fatalf("native content was not captured: %+v, %v", definition, err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestLoadRejectsMalformedStaticSyntaxAndAmbiguousSelection(t *testing.T) {
|
func TestLoadRejectsMalformedStaticSyntax(t *testing.T) {
|
||||||
_, err := load(mapping("bad-template", map[string]any{"prompts": map[string]any{"example": map[string]any{
|
_, err := load(mapping("bad-template", map[string]any{"prompts": []any{map[string]any{"id": "example",
|
||||||
"v1": map[string]any{"messages": []any{map[string]any{"role": "user", "content": "{{if}}"}},
|
"messages": []any{map[string]any{"role": "user", "content": "{{if}}"}},
|
||||||
"output": map[string]any{"format": "text", "validation_mode": "basic"}},
|
"output": map[string]any{"format": "text", "validation_mode": "basic"},
|
||||||
}}}), nil)
|
}}}), nil)
|
||||||
if err == nil || !strings.Contains(err.Error(), "invalid template syntax") {
|
if err == nil || !strings.Contains(err.Error(), "invalid template syntax") {
|
||||||
t.Fatalf("expected construction-time syntax error, got %v", err)
|
t.Fatalf("expected construction-time syntax error, got %v", err)
|
||||||
}
|
}
|
||||||
state, err := load(mapping("versions", map[string]any{"prompts": map[string]any{"example": map[string]any{
|
|
||||||
"v1": map[string]any{"messages": []any{map[string]any{"role": "user", "content": "one"}},
|
|
||||||
"output": map[string]any{"format": "text", "validation_mode": "basic"}},
|
|
||||||
"v2": map[string]any{"messages": []any{map[string]any{"role": "user", "content": "two"}},
|
|
||||||
"output": map[string]any{"format": "text", "validation_mode": "basic"}},
|
|
||||||
}}}), nil)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
if _, _, err := state.prompt("example", ""); !errors.Is(err, errPromptAmbiguous) {
|
|
||||||
t.Fatalf("expected ambiguous version selection, got %v", err)
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestPromptInspectionLookupMatchesSnapshotSelectionAndOwnsInputs(t *testing.T) {
|
func TestPromptInspectionLookupMatchesSnapshotSelectionAndOwnsInputs(t *testing.T) {
|
||||||
@@ -148,32 +184,26 @@ func TestPromptInspectionLookupMatchesSnapshotSelectionAndOwnsInputs(t *testing.
|
|||||||
"output": map[string]any{"format": "text", "validation_mode": "none"},
|
"output": map[string]any{"format": "text", "validation_mode": "none"},
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
selectedPrompt := makePrompt("selected")
|
||||||
|
selectedPrompt["id"] = "selected"
|
||||||
state, err := load(mapping("prompt inspection lookup", map[string]any{
|
state, err := load(mapping("prompt inspection lookup", map[string]any{
|
||||||
"profiles": map[string]any{"partial": map[string]any{}},
|
"profiles": []any{map[string]any{"id": "partial"}},
|
||||||
"prompts": map[string]any{
|
"prompts": []any{selectedPrompt},
|
||||||
"multi": map[string]any{"v1": makePrompt("first"), "v2": makePrompt("second")},
|
|
||||||
"single": map[string]any{"v1": makePrompt("only")},
|
|
||||||
},
|
|
||||||
}), nil)
|
}), nil)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
|
|
||||||
for _, selection := range []struct {
|
{
|
||||||
id, version string
|
inspection, err := state.GetPromptInspection(context.Background(), "selected")
|
||||||
}{
|
|
||||||
{id: "multi", version: "v2"},
|
|
||||||
{id: "single"},
|
|
||||||
} {
|
|
||||||
inspection, err := state.GetPromptInspection(context.Background(), selection.id, selection.version)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("inspect %q/%q: %v", selection.id, selection.version, err)
|
t.Fatalf("inspect prompt ID: %v", err)
|
||||||
}
|
}
|
||||||
definition, hash, err := state.GetPromptSnapshot(context.Background(), selection.id, selection.version)
|
definition, hash, err := state.GetPromptSnapshot(context.Background(), "selected")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("snapshot %q/%q: %v", selection.id, selection.version, err)
|
t.Fatalf("snapshot prompt ID: %v", err)
|
||||||
}
|
}
|
||||||
if inspection.PromptID != definition.ID || inspection.PromptVersion != definition.Version ||
|
if inspection.PromptID != definition.ID ||
|
||||||
inspection.PromptHash != hash || inspection.DefaultProfileID != "partial" ||
|
inspection.PromptHash != hash || inspection.DefaultProfileID != "partial" ||
|
||||||
len(inspection.Inputs) != 1 || inspection.Inputs[0].Name != "document" ||
|
len(inspection.Inputs) != 1 || inspection.Inputs[0].Name != "document" ||
|
||||||
inspection.Inputs[0].ContentType != "text/plain" || inspection.Inputs[0].Description != "source document" {
|
inspection.Inputs[0].ContentType != "text/plain" || inspection.Inputs[0].Description != "source document" {
|
||||||
@@ -184,53 +214,41 @@ func TestPromptInspectionLookupMatchesSnapshotSelectionAndOwnsInputs(t *testing.
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
owned, err := state.GetPromptInspection(context.Background(), "single", "")
|
owned, err := state.GetPromptInspection(context.Background(), "selected")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
owned.Inputs[0].Name = "caller mutation"
|
owned.Inputs[0].Name = "caller mutation"
|
||||||
owned.Inputs[0].Description = "caller mutation"
|
owned.Inputs[0].Description = "caller mutation"
|
||||||
again, err := state.GetPromptInspection(context.Background(), "single", "v1")
|
again, err := state.GetPromptInspection(context.Background(), "selected")
|
||||||
if err != nil || again.Inputs[0].Name != "document" || again.Inputs[0].Description != "source document" {
|
if err != nil || again.Inputs[0].Name != "document" || again.Inputs[0].Description != "source document" {
|
||||||
t.Fatalf("inspection mutation escaped into captured state: inspection=%+v err=%v", again, err)
|
t.Fatalf("inspection mutation escaped into captured state: inspection=%+v err=%v", again, err)
|
||||||
}
|
}
|
||||||
|
|
||||||
for _, selection := range []struct {
|
for _, id := range []string{"missing", " "} {
|
||||||
id, version string
|
inspection, err := state.GetPromptInspection(context.Background(), id)
|
||||||
}{
|
|
||||||
{id: "missing", version: "v1"},
|
|
||||||
{id: "multi", version: "V2"},
|
|
||||||
{id: " ", version: "v1"},
|
|
||||||
} {
|
|
||||||
inspection, err := state.GetPromptInspection(context.Background(), selection.id, selection.version)
|
|
||||||
if inspection != nil || !errors.Is(err, promptdef.ErrPromptDefinitionNotFound) {
|
if inspection != nil || !errors.Is(err, promptdef.ErrPromptDefinitionNotFound) {
|
||||||
t.Errorf("inspection selection %q/%q=(%+v, %v), want not found", selection.id, selection.version, inspection, err)
|
t.Errorf("inspection lookup %q=(%+v, %v), want not found", id, inspection, err)
|
||||||
}
|
}
|
||||||
definition, _, err := state.GetPromptSnapshot(context.Background(), selection.id, selection.version)
|
definition, _, err := state.GetPromptSnapshot(context.Background(), id)
|
||||||
if definition != nil || !errors.Is(err, promptdef.ErrPromptDefinitionNotFound) {
|
if definition != nil || !errors.Is(err, promptdef.ErrPromptDefinitionNotFound) {
|
||||||
t.Errorf("snapshot selection %q/%q=(%+v, %v), want not found", selection.id, selection.version, definition, err)
|
t.Errorf("snapshot lookup %q=(%+v, %v), want not found", id, definition, err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
if _, err := state.GetPromptInspection(context.Background(), "multi", ""); !errors.Is(err, errPromptAmbiguous) {
|
|
||||||
t.Errorf("ambiguous inspection selection error=%v", err)
|
|
||||||
}
|
|
||||||
if _, _, err := state.GetPromptSnapshot(context.Background(), "multi", ""); !errors.Is(err, errPromptAmbiguous) {
|
|
||||||
t.Errorf("ambiguous snapshot selection error=%v", err)
|
|
||||||
}
|
|
||||||
ctx, cancel := context.WithCancel(context.Background())
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
cancel()
|
cancel()
|
||||||
if _, err := state.GetPromptInspection(ctx, "single", "v1"); !errors.Is(err, context.Canceled) {
|
if _, err := state.GetPromptInspection(ctx, "selected"); !errors.Is(err, context.Canceled) {
|
||||||
t.Errorf("canceled inspection selection error=%v", err)
|
t.Errorf("canceled inspection selection error=%v", err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestLoadAcceptsEmptyInlineContentAndRejectsInvalidPromptFields(t *testing.T) {
|
func TestLoadAcceptsEmptyInlineContentAndRejectsInvalidPromptFields(t *testing.T) {
|
||||||
state, err := load(mapping("empty-content", map[string]any{"prompts": map[string]any{" exact.id ": map[string]any{"v1": map[string]any{
|
state, err := load(mapping("empty-content", map[string]any{"prompts": []any{map[string]any{"id": " exact.id ",
|
||||||
"inputs": []any{map[string]any{"name": " note ", "required": true}},
|
"inputs": []any{map[string]any{"name": " note ", "required": true}},
|
||||||
"messages": []any{map[string]any{"role": " USER ", "content": "", "content_file": nil,
|
"messages": []any{map[string]any{"role": " USER ", "content": "", "content_file": nil,
|
||||||
"cache_control": map[string]any{"type": " ephemeral ", "ttl": "1h "}}},
|
"cache_control": map[string]any{"type": " ephemeral ", "ttl": "1h "}}},
|
||||||
"output": map[string]any{"format": "text", "validation_mode": "basic"},
|
"output": map[string]any{"format": "text", "validation_mode": "basic"},
|
||||||
}}}}), nil)
|
}}}), nil)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
var loadError *configkit.LoadError
|
var loadError *configkit.LoadError
|
||||||
if errors.As(err, &loadError) {
|
if errors.As(err, &loadError) {
|
||||||
@@ -238,23 +256,24 @@ func TestLoadAcceptsEmptyInlineContentAndRejectsInvalidPromptFields(t *testing.T
|
|||||||
}
|
}
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
definition, _, err := state.prompt(" exact.id ", "v1")
|
definition, _, err := state.prompt(" exact.id ")
|
||||||
if err != nil || definition.ID != " exact.id " || definition.Templates[0].Content != "" || definition.Templates[0].Role != "user" ||
|
if err != nil || definition.ID != " exact.id " || definition.Templates[0].Content != "" || definition.Templates[0].Role != "user" ||
|
||||||
definition.Inputs[0].Name != "note" || definition.Templates[0].CacheControl.TTL != "1h" {
|
definition.Inputs[0].Name != "note" || definition.Templates[0].CacheControl.TTL != "1h" {
|
||||||
t.Fatalf("explicit empty content or literal ID was changed: %+v, %v", definition, err)
|
t.Fatalf("explicit empty content or literal ID was changed: %+v, %v", definition, err)
|
||||||
}
|
}
|
||||||
if _, _, err := state.prompt("exact.id", "v1"); !errors.Is(err, errPromptNotFound) {
|
if _, _, err := state.prompt("exact.id"); !errors.Is(err, errPromptNotFound) {
|
||||||
t.Fatalf("trimmed prompt identity unexpectedly matched: %v", err)
|
t.Fatalf("trimmed prompt identity unexpectedly matched: %v", err)
|
||||||
}
|
}
|
||||||
_, err = load(mapping("obsolete-field", map[string]any{"prompts": map[string]any{"example": map[string]any{"v1": map[string]any{
|
_, err = load(mapping("obsolete-field", map[string]any{"prompts": []any{map[string]any{
|
||||||
"id": "example", "messages": []any{map[string]any{"role": "user", "content": "ok"}},
|
"version": "v1",
|
||||||
|
"id": "example", "messages": []any{map[string]any{"role": "user", "content": "ok"}},
|
||||||
"output": map[string]any{"format": "text", "validation_mode": "basic"},
|
"output": map[string]any{"format": "text", "validation_mode": "basic"},
|
||||||
}}}}), nil)
|
}}}), nil)
|
||||||
var loadError *configkit.LoadError
|
var loadError *configkit.LoadError
|
||||||
if !errors.As(err, &loadError) {
|
if !errors.As(err, &loadError) {
|
||||||
t.Fatalf("obsolete identity field should fail strict decoding: %v", err)
|
t.Fatalf("obsolete identity field should fail strict decoding: %v", err)
|
||||||
}
|
}
|
||||||
_, err = load(mapping("null-prompt", map[string]any{"prompts": map[string]any{"example": nil}}), nil)
|
_, err = load(mapping("null-prompt", map[string]any{"prompts": []any{nil}}), nil)
|
||||||
if err == nil {
|
if err == nil {
|
||||||
t.Fatal("null prompt collection was accepted")
|
t.Fatal("null prompt collection was accepted")
|
||||||
}
|
}
|
||||||
@@ -262,7 +281,8 @@ func TestLoadAcceptsEmptyInlineContentAndRejectsInvalidPromptFields(t *testing.T
|
|||||||
|
|
||||||
func TestRequirementSnapshotCapturesMetadataPresenceAndNormalizedValues(t *testing.T) {
|
func TestRequirementSnapshotCapturesMetadataPresenceAndNormalizedValues(t *testing.T) {
|
||||||
state, err := load(mapping("requirement-metadata", map[string]any{
|
state, err := load(mapping("requirement-metadata", map[string]any{
|
||||||
"prompts": map[string]any{"example": map[string]any{"v1": map[string]any{
|
"prompts": []any{map[string]any{
|
||||||
|
"id": "example",
|
||||||
"session_id": "{{.session}}",
|
"session_id": "{{.session}}",
|
||||||
"inputs": []any{
|
"inputs": []any{
|
||||||
map[string]any{"name": "absent"},
|
map[string]any{"name": "absent"},
|
||||||
@@ -272,7 +292,7 @@ func TestRequirementSnapshotCapturesMetadataPresenceAndNormalizedValues(t *testi
|
|||||||
},
|
},
|
||||||
"messages": []any{map[string]any{"role": "user", "content": "{{input \"absent\"}}"}},
|
"messages": []any{map[string]any{"role": "user", "content": "{{input \"absent\"}}"}},
|
||||||
"output": map[string]any{"format": "text", "validation_mode": "basic"},
|
"output": map[string]any{"format": "text", "validation_mode": "basic"},
|
||||||
}}},
|
}},
|
||||||
}), nil)
|
}), nil)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
var loadError *configkit.LoadError
|
var loadError *configkit.LoadError
|
||||||
@@ -282,7 +302,7 @@ func TestRequirementSnapshotCapturesMetadataPresenceAndNormalizedValues(t *testi
|
|||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
|
|
||||||
snapshot, ok := state.GetRequirementSnapshot("example", "v1")
|
snapshot, ok := state.GetRequirementSnapshot("example")
|
||||||
if !ok || len(snapshot.Inputs) != 4 || len(snapshot.Templates.Messages) != 1 || snapshot.Templates.Session == nil {
|
if !ok || len(snapshot.Inputs) != 4 || len(snapshot.Templates.Messages) != 1 || snapshot.Templates.Session == nil {
|
||||||
t.Fatalf("requirement snapshot was not captured: %+v, %t", snapshot, ok)
|
t.Fatalf("requirement snapshot was not captured: %+v, %t", snapshot, ok)
|
||||||
}
|
}
|
||||||
@@ -300,7 +320,7 @@ func TestRequirementSnapshotCapturesMetadataPresenceAndNormalizedValues(t *testi
|
|||||||
t.Errorf("snapshot did not use normalized final metadata: %+v", snapshot.Inputs[3])
|
t.Errorf("snapshot did not use normalized final metadata: %+v", snapshot.Inputs[3])
|
||||||
}
|
}
|
||||||
|
|
||||||
definition, inspection, err := state.prompt("example", "v1")
|
definition, inspection, err := state.prompt("example")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
@@ -312,13 +332,10 @@ func TestRequirementSnapshotCapturesMetadataPresenceAndNormalizedValues(t *testi
|
|||||||
*snapshot.Inputs[2].ContentType = "caller mutation"
|
*snapshot.Inputs[2].ContentType = "caller mutation"
|
||||||
snapshot.Inputs[3].Name = "caller mutation"
|
snapshot.Inputs[3].Name = "caller mutation"
|
||||||
snapshot.Templates.Messages[0] = nil
|
snapshot.Templates.Messages[0] = nil
|
||||||
again, ok := state.GetRequirementSnapshot("example", "v1")
|
again, ok := state.GetRequirementSnapshot("example")
|
||||||
if !ok || *again.Inputs[2].ContentType != "" || again.Inputs[3].Name != "normalized" || again.Templates.Messages[0] == nil {
|
if !ok || *again.Inputs[2].ContentType != "" || again.Inputs[3].Name != "normalized" || again.Templates.Messages[0] == nil {
|
||||||
t.Fatalf("snapshot mutation escaped into captured state: %+v, %t", again, ok)
|
t.Fatalf("snapshot mutation escaped into captured state: %+v, %t", again, ok)
|
||||||
}
|
}
|
||||||
if _, ok := state.GetRequirementSnapshot("example", "V1"); ok {
|
|
||||||
t.Fatal("snapshot lookup unexpectedly changed exact version matching")
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestInputMetadataPresenceDoesNotChangePromptHashOrInspection(t *testing.T) {
|
func TestInputMetadataPresenceDoesNotChangePromptHashOrInspection(t *testing.T) {
|
||||||
@@ -338,11 +355,12 @@ func TestInputMetadataPresenceDoesNotChangePromptHashOrInspection(t *testing.T)
|
|||||||
input[name] = value
|
input[name] = value
|
||||||
}
|
}
|
||||||
state, err := load(mapping("hash-"+variant.name, map[string]any{
|
state, err := load(mapping("hash-"+variant.name, map[string]any{
|
||||||
"prompts": map[string]any{"same": map[string]any{"v1": map[string]any{
|
"prompts": []any{map[string]any{
|
||||||
|
"id": "same",
|
||||||
"inputs": []any{input},
|
"inputs": []any{input},
|
||||||
"messages": []any{map[string]any{"role": "user", "content": "hello"}},
|
"messages": []any{map[string]any{"role": "user", "content": "hello"}},
|
||||||
"output": map[string]any{"format": "text", "validation_mode": "basic"},
|
"output": map[string]any{"format": "text", "validation_mode": "basic"},
|
||||||
}}},
|
}},
|
||||||
}), nil)
|
}), nil)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
var loadError *configkit.LoadError
|
var loadError *configkit.LoadError
|
||||||
@@ -351,7 +369,7 @@ func TestInputMetadataPresenceDoesNotChangePromptHashOrInspection(t *testing.T)
|
|||||||
}
|
}
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
_, inspection, err := state.prompt("same", "v1")
|
_, inspection, err := state.prompt("same")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
@@ -368,10 +386,11 @@ func TestInputMetadataPresenceDoesNotChangePromptHashOrInspection(t *testing.T)
|
|||||||
}
|
}
|
||||||
|
|
||||||
func promptWithFile(name string) map[string]any {
|
func promptWithFile(name string) map[string]any {
|
||||||
return map[string]any{"prompts": map[string]any{"example": map[string]any{"v1": map[string]any{
|
return map[string]any{"prompts": []any{map[string]any{
|
||||||
|
"id": "example",
|
||||||
"messages": []any{map[string]any{"role": "user", "content_file": name}},
|
"messages": []any{map[string]any{"role": "user", "content_file": name}},
|
||||||
"output": map[string]any{"format": "text", "validation_mode": "basic"},
|
"output": map[string]any{"format": "text", "validation_mode": "basic"},
|
||||||
}}}}
|
}}}
|
||||||
}
|
}
|
||||||
|
|
||||||
type countingFS struct {
|
type countingFS struct {
|
||||||
|
|||||||
@@ -4,22 +4,33 @@ import (
|
|||||||
"context"
|
"context"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/backend"
|
"go.maximumdirect.net/promptkit/internal/backend"
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/defaults"
|
"go.maximumdirect.net/promptkit/internal/defaults"
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/domain"
|
"go.maximumdirect.net/promptkit/internal/domain"
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/jsonvalue"
|
"go.maximumdirect.net/promptkit/internal/jsonvalue"
|
||||||
profilepkg "gitea.maximumdirect.net/eric/promptkit/internal/profile"
|
profilepkg "go.maximumdirect.net/promptkit/internal/profile"
|
||||||
)
|
)
|
||||||
|
|
||||||
func (state *loaded) buildExecutionProfiles() error {
|
func (state *loaded) buildExecutionProfiles() error {
|
||||||
definitions := make(map[string]domain.Backend, len(state.result.Config.Backends))
|
backendConfigs := indexedBackends(&state.interpreted)
|
||||||
for _, id := range sortedKeys(state.result.Config.Backends) {
|
profileConfigs := indexedProfiles(&state.interpreted)
|
||||||
config := state.result.Config.Backends[id]
|
definitions := make(map[string]domain.Backend, len(backendConfigs))
|
||||||
params, err := jsonvalue.CopyMap(config.ExtraParams)
|
for _, id := range sortedKeys(backendConfigs) {
|
||||||
if err != nil {
|
config := backendConfigs[id]
|
||||||
return fmt.Errorf("backend %q extra parameters: %w", id, err)
|
definition := domain.Backend{ID: id, ExtraParams: config.ExtraParams}
|
||||||
|
if config.SmokeTests != nil {
|
||||||
|
smokeTests := &domain.BackendSmokeTestConfig{DefaultProfile: config.SmokeTests.DefaultProfile}
|
||||||
|
if config.SmokeTests.Reachability != nil {
|
||||||
|
smokeTests.Reachability = &domain.ReachabilityProbeConfig{Endpoint: config.SmokeTests.Reachability.Endpoint}
|
||||||
|
}
|
||||||
|
if config.SmokeTests.Authentication != nil {
|
||||||
|
smokeTests.Authentication = &domain.AuthenticationProbeConfig{
|
||||||
|
Kind: config.SmokeTests.Authentication.Kind,
|
||||||
|
Endpoint: config.SmokeTests.Authentication.Endpoint,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
definition.SmokeTests = smokeTests
|
||||||
}
|
}
|
||||||
definition := domain.Backend{ID: id, ExtraParams: params}
|
|
||||||
if config.Endpoint != nil {
|
if config.Endpoint != nil {
|
||||||
definition.Endpoint = *config.Endpoint
|
definition.Endpoint = *config.Endpoint
|
||||||
}
|
}
|
||||||
@@ -40,9 +51,9 @@ func (state *loaded) buildExecutionProfiles() error {
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
state.registry = registry
|
state.registry = registry
|
||||||
state.indexedProfiles = make(map[string]domain.ExecutionProfile, len(state.result.Config.Profiles))
|
state.indexedProfiles = make(map[string]domain.ExecutionProfile, len(profileConfigs))
|
||||||
for _, id := range sortedKeys(state.result.Config.Profiles) {
|
for _, id := range sortedKeys(profileConfigs) {
|
||||||
config := state.result.Config.Profiles[id]
|
config := profileConfigs[id]
|
||||||
fields := state.profiles[id]
|
fields := state.profiles[id]
|
||||||
target := defaults.ExecutionTargetDefault()
|
target := defaults.ExecutionTargetDefault()
|
||||||
if config.Backend != nil && *config.Backend != "" {
|
if config.Backend != nil && *config.Backend != "" {
|
||||||
|
|||||||
@@ -9,36 +9,88 @@ import (
|
|||||||
"reflect"
|
"reflect"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/defaults"
|
"go.maximumdirect.net/promptkit/internal/defaults"
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/domain"
|
"go.maximumdirect.net/promptkit/internal/domain"
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/llm"
|
"go.maximumdirect.net/promptkit/internal/llm"
|
||||||
profilepkg "gitea.maximumdirect.net/eric/promptkit/internal/profile"
|
profilepkg "go.maximumdirect.net/promptkit/internal/profile"
|
||||||
|
"go.maximumdirect.net/promptkit/internal/prompt"
|
||||||
|
"go.maximumdirect.net/promptkit/internal/usecase"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
func TestLoadIndexesIdentifiedTargets(t *testing.T) {
|
||||||
|
values := map[string]any{
|
||||||
|
"backends": []any{map[string]any{"id": "local", "endpoint": "https://root.example/v1"}},
|
||||||
|
"profiles": []any{map[string]any{"id": "partial", "backend": "local"}},
|
||||||
|
"collections": map[string]any{},
|
||||||
|
}
|
||||||
|
collections := values["collections"].(map[string]any)
|
||||||
|
for _, namespace := range []string{"north", "south"} {
|
||||||
|
collections[namespace] = map[string]any{
|
||||||
|
"backends": []any{map[string]any{"id": "local", "endpoint": "https://" + namespace + ".example/v1"}},
|
||||||
|
"profiles": []any{map[string]any{"id": "partial", "backend": namespace + "/local"}},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
state, err := load(mapping("identified targets", values), nil)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
for id, backendID := range map[string]string{"partial": "local", "north/partial": "north/local", "south/partial": "south/local"} {
|
||||||
|
profile, err := state.GetProfile(context.Background(), id)
|
||||||
|
if err != nil || profile.ID != id || profile.ResolvedTarget == nil || profile.ResolvedTarget.Model != "" || profile.ResolvedTarget.BackendID != backendID {
|
||||||
|
t.Fatalf("partial profile %q = %+v, %v", id, profile, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRequestCompletesLoadedPartialProfile(t *testing.T) {
|
||||||
|
state, err := load(mapping("partial profile", map[string]any{
|
||||||
|
"profiles": []any{map[string]any{"id": "partial"}},
|
||||||
|
"prompts": []any{map[string]any{
|
||||||
|
"id": "example", "messages": []any{map[string]any{"role": "user", "content": "hello"}},
|
||||||
|
"output": map[string]any{"format": "text", "validation_mode": "basic"},
|
||||||
|
}},
|
||||||
|
}), nil)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
runner := usecase.NewRunner(state, state, nil, prompt.NewGoRenderer(), nil, nil, nil)
|
||||||
|
prepared, err := runner.Prepare(context.Background(), domain.RunRequest{
|
||||||
|
PromptID: "example", ProfileID: "partial",
|
||||||
|
Execution: &domain.ExecutionTargetOverride{Endpoint: "https://example.invalid/v1", Model: "request-model"},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if prepared.SelectedProfileID != "partial" || prepared.EffectiveModelParams.Endpoint != "https://example.invalid/v1" ||
|
||||||
|
prepared.EffectiveModelParams.Model != "request-model" {
|
||||||
|
t.Fatalf("request did not complete the loaded profile: %+v", prepared)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestLoadBuildsEffectiveTargetsAfterInheritance(t *testing.T) {
|
func TestLoadBuildsEffectiveTargetsAfterInheritance(t *testing.T) {
|
||||||
state, err := load(mapping("effective-targets", map[string]any{
|
state, err := load(mapping("effective-targets", map[string]any{
|
||||||
"backends": map[string]any{
|
"backends": []any{
|
||||||
"first": map[string]any{"endpoint": "https://first.example/v1", "api_key_env": "FIRST_KEY",
|
map[string]any{"id": "first", "endpoint": "https://first.example/v1", "api_key_env": "FIRST_KEY",
|
||||||
"extra_params": map[string]any{"source": "first", "nested": map[string]any{"old": true}}},
|
"extra_params": map[string]any{"source": "first", "nested": map[string]any{"old": true}}},
|
||||||
"second": map[string]any{"endpoint": "https://second.example/v1", "api_key_env": "SECOND_KEY",
|
map[string]any{"id": "second", "endpoint": "https://second.example/v1", "api_key_env": "SECOND_KEY",
|
||||||
"concurrency_limit": 2, "queue_capacity": 0,
|
"concurrency_limit": 2, "queue_capacity": 0,
|
||||||
"extra_params": map[string]any{"source": "second", "nested": map[string]any{"backend": true}}},
|
"extra_params": map[string]any{"source": "second", "nested": map[string]any{"backend": true}}},
|
||||||
},
|
},
|
||||||
"profiles": map[string]any{
|
"profiles": []any{
|
||||||
"base": map[string]any{"backend": "first", "model": "model", "temperature": 0.8,
|
map[string]any{"id": "base", "backend": "first", "model": "model", "temperature": 0.8,
|
||||||
"top_p": 0.9, "max_tokens": 100, "timeout_seconds": 30, "api_key_required": true,
|
"top_p": 0.9, "max_tokens": 100, "timeout_seconds": 30, "api_key_required": true,
|
||||||
"extra_params": map[string]any{"nested": map[string]any{"profile": true}}},
|
"extra_params": map[string]any{"nested": map[string]any{"profile": true}}},
|
||||||
"child": map[string]any{"extends": "base", "backend": "second", "temperature": 0.0,
|
map[string]any{"id": "child", "extends": map[string]any{"id": "base"}, "backend": "second", "temperature": 0.0,
|
||||||
"top_p": nil, "max_tokens": 0, "timeout_seconds": nil, "api_key_env": nil,
|
"top_p": nil, "max_tokens": 0, "timeout_seconds": nil, "api_key_env": nil,
|
||||||
"api_key_required": false,
|
"api_key_required": false,
|
||||||
"extra_params": map[string]any{"nested": map[string]any{"child": nil}}},
|
"extra_params": map[string]any{"nested": map[string]any{"child": nil}}},
|
||||||
"direct-key": map[string]any{"backend": "second", "api_key_required": true},
|
map[string]any{"id": "direct-key", "backend": "second", "api_key_required": true},
|
||||||
"named-key": map[string]any{"backend": "second", "api_key_required": true, "api_key_env": "CUSTOM_KEY"},
|
map[string]any{"id": "named-key", "backend": "second", "api_key_required": true, "api_key_env": "CUSTOM_KEY"},
|
||||||
"no-provider-map": map[string]any{"backend": "second", "extra_params": nil},
|
map[string]any{"id": "no-provider-map", "backend": "second", "extra_params": nil},
|
||||||
"no-timeout": map[string]any{"backend": "second", "timeout_seconds": 0},
|
map[string]any{"id": "no-timeout", "backend": "second", "timeout_seconds": 0},
|
||||||
"partial": map[string]any{},
|
map[string]any{"id": "partial"},
|
||||||
"endpoint-only": map[string]any{"endpoint": "https://standalone.example/v1"},
|
map[string]any{"id": "endpoint-only", "endpoint": "https://standalone.example/v1"},
|
||||||
"cleared-endpoint": map[string]any{"extends": "base", "endpoint": nil},
|
map[string]any{"id": "cleared-endpoint", "extends": map[string]any{"id": "base"}, "endpoint": nil},
|
||||||
},
|
},
|
||||||
}), nil)
|
}), nil)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -133,9 +185,9 @@ func TestLoadedZeroControlsReachBuiltInRequest(t *testing.T) {
|
|||||||
}))
|
}))
|
||||||
defer server.Close()
|
defer server.Close()
|
||||||
state, err := load(mapping("wire-controls", map[string]any{
|
state, err := load(mapping("wire-controls", map[string]any{
|
||||||
"backends": map[string]any{"local": map[string]any{"endpoint": server.URL + "/v1"}},
|
"backends": []any{map[string]any{"id": "local", "endpoint": server.URL + "/v1"}},
|
||||||
"profiles": map[string]any{"direct": map[string]any{
|
"profiles": []any{map[string]any{
|
||||||
"backend": "local", "model": "example", "temperature": 0.0, "max_tokens": 0, "top_p": nil,
|
"id": "direct", "backend": "local", "model": "example", "temperature": 0.0, "max_tokens": 0, "top_p": nil,
|
||||||
}},
|
}},
|
||||||
}), nil)
|
}), nil)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
|||||||
@@ -3,7 +3,7 @@ package defaults
|
|||||||
import (
|
import (
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/promptkit/internal/domain"
|
"go.maximumdirect.net/promptkit/internal/domain"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
|
|||||||
@@ -61,7 +61,6 @@ type CacheControl struct {
|
|||||||
// RunRequest represents a request to generate a single artifact.
|
// RunRequest represents a request to generate a single artifact.
|
||||||
type RunRequest struct {
|
type RunRequest struct {
|
||||||
PromptID string
|
PromptID string
|
||||||
PromptVersion string
|
|
||||||
ProfileID string
|
ProfileID string
|
||||||
SessionID string
|
SessionID string
|
||||||
APIKey string `json:"-" yaml:"-"`
|
APIKey string `json:"-" yaml:"-"`
|
||||||
@@ -81,7 +80,6 @@ type RunResult struct {
|
|||||||
RawOutput string
|
RawOutput string
|
||||||
Validation ValidationResult
|
Validation ValidationResult
|
||||||
PromptID string
|
PromptID string
|
||||||
PromptVersion string
|
|
||||||
PromptHash string
|
PromptHash string
|
||||||
SessionID string
|
SessionID string
|
||||||
RenderedPromptHash string
|
RenderedPromptHash string
|
||||||
@@ -101,7 +99,6 @@ type RunResult struct {
|
|||||||
// It must never include resolved API key values, model output, or validation data.
|
// It must never include resolved API key values, model output, or validation data.
|
||||||
type PreparedRun struct {
|
type PreparedRun struct {
|
||||||
PromptID string
|
PromptID string
|
||||||
PromptVersion string
|
|
||||||
PromptHash string
|
PromptHash string
|
||||||
SelectedProfileID string
|
SelectedProfileID string
|
||||||
SelectedBackendID string
|
SelectedBackendID string
|
||||||
@@ -135,16 +132,14 @@ type Artifact struct {
|
|||||||
Hash string
|
Hash string
|
||||||
}
|
}
|
||||||
|
|
||||||
// PromptIdentity identifies one configured prompt version.
|
// PromptIdentity identifies one configured prompt.
|
||||||
type PromptIdentity struct {
|
type PromptIdentity struct {
|
||||||
ID string
|
ID string
|
||||||
Version string
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// PromptDefinition represents a configured prompt execution definition.
|
// PromptDefinition represents a configured prompt execution definition.
|
||||||
type PromptDefinition struct {
|
type PromptDefinition struct {
|
||||||
ID string `yaml:"id"`
|
ID string `yaml:"id"`
|
||||||
Version string `yaml:"version"`
|
|
||||||
DefaultProfile string `yaml:"default_profile"`
|
DefaultProfile string `yaml:"default_profile"`
|
||||||
Description string `yaml:"description"`
|
Description string `yaml:"description"`
|
||||||
SessionID string `yaml:"session_id" json:"session_id,omitempty"`
|
SessionID string `yaml:"session_id" json:"session_id,omitempty"`
|
||||||
@@ -157,7 +152,6 @@ type PromptDefinition struct {
|
|||||||
// PromptInspection is the resolved result of exact prompt inspection.
|
// PromptInspection is the resolved result of exact prompt inspection.
|
||||||
type PromptInspection struct {
|
type PromptInspection struct {
|
||||||
PromptID string
|
PromptID string
|
||||||
PromptVersion string
|
|
||||||
PromptHash string
|
PromptHash string
|
||||||
DefaultProfileID string
|
DefaultProfileID string
|
||||||
Inputs []PromptInput
|
Inputs []PromptInput
|
||||||
@@ -180,12 +174,14 @@ type PromptMessageTemplate struct {
|
|||||||
CacheControl *CacheControl `yaml:"cache_control,omitempty" json:"cache_control,omitempty"`
|
CacheControl *CacheControl `yaml:"cache_control,omitempty" json:"cache_control,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// Backend describes reusable OpenAI-compatible connection defaults.
|
// Backend describes reusable OpenAI-compatible connection defaults and optional
|
||||||
|
// diagnostic metadata.
|
||||||
type Backend struct {
|
type Backend struct {
|
||||||
ID string
|
ID string
|
||||||
Endpoint string
|
Endpoint string
|
||||||
APIKeyEnv string
|
APIKeyEnv string
|
||||||
ExtraParams map[string]any
|
ExtraParams map[string]any
|
||||||
|
SmokeTests *BackendSmokeTestConfig
|
||||||
ConcurrencyLimit int
|
ConcurrencyLimit int
|
||||||
QueueCapacity int
|
QueueCapacity int
|
||||||
QueueCapacitySet bool
|
QueueCapacitySet bool
|
||||||
|
|||||||
@@ -68,7 +68,6 @@ type ExecutionEvent struct {
|
|||||||
RunID string
|
RunID string
|
||||||
Time time.Time
|
Time time.Time
|
||||||
PromptID string
|
PromptID string
|
||||||
PromptVersion string
|
|
||||||
ProfileID string
|
ProfileID string
|
||||||
BackendID string
|
BackendID string
|
||||||
Model string
|
Model string
|
||||||
|
|||||||
@@ -48,11 +48,10 @@ type RequirementIssue struct {
|
|||||||
|
|
||||||
// RequirementInspection contains the inventories discovered for one prompt.
|
// RequirementInspection contains the inventories discovered for one prompt.
|
||||||
type RequirementInspection struct {
|
type RequirementInspection struct {
|
||||||
PromptID string
|
PromptID string
|
||||||
PromptVersion string
|
ProfileID string
|
||||||
ProfileID string
|
Inputs []InputRequirement
|
||||||
Inputs []InputRequirement
|
Variables []VariableRequirement
|
||||||
Variables []VariableRequirement
|
Complete bool
|
||||||
Complete bool
|
Issues []RequirementIssue
|
||||||
Issues []RequirementIssue
|
|
||||||
}
|
}
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user