75 lines
2.3 KiB
Markdown
75 lines
2.3 KiB
Markdown
# Promptkit v0.3.0
|
|
|
|
This supplemental changelog summarizes the consumer-facing changes from
|
|
`v0.2.0` to `v0.3.0`. The annotated `v0.3.0` tag is the authoritative release
|
|
record. Exact current contracts belong to the linked GoDoc and durable
|
|
documentation.
|
|
|
|
## Summary
|
|
|
|
`v0.3.0` adds a concise way to register the common local OpenAI-compatible
|
|
backend configuration:
|
|
|
|
- `BackendLocal` provides the conventional, non-reserved backend ID `"local"`;
|
|
and
|
|
- `LocalBackend` constructs an ordinary `Backend` from an endpoint and
|
|
concurrency limit.
|
|
|
|
The helper is explicit and additive. It does not pre-register a backend, read
|
|
environment variables, select a model, or replace the complete `Backend`
|
|
configuration interface.
|
|
|
|
## Compatibility
|
|
|
|
Existing `v0.2.0` consumers require no migration. Endpoint-only profiles,
|
|
complete custom `Backend` values, the built-in OpenRouter backend, and existing
|
|
registrations using the literal ID `"local"` continue to work unchanged.
|
|
|
|
## Upgrade
|
|
|
|
Update the module dependency with:
|
|
|
|
```sh
|
|
go get gitea.maximumdirect.net/eric/promptkit@v0.3.0
|
|
go mod tidy
|
|
```
|
|
|
|
Run the consuming project's ordinary tests and race-enabled tests after the
|
|
upgrade.
|
|
|
|
## Configure A Local Backend
|
|
|
|
Register the convenience value through the existing `WithBackend` option and
|
|
select it from one or more profiles:
|
|
|
|
```go
|
|
engine, err := promptkit.NewEngine(
|
|
promptkit.Config{PromptDir: "prompts"},
|
|
promptkit.WithBackend(
|
|
promptkit.LocalBackend("http://localhost:8000/v1", 2),
|
|
),
|
|
promptkit.WithProfiles(promptkit.Profile{
|
|
ID: "local-summary",
|
|
BackendID: promptkit.BackendLocal,
|
|
Model: "example-model",
|
|
}),
|
|
)
|
|
```
|
|
|
|
Use an endpoint-only profile when shared backend identity and capacity policy
|
|
are unnecessary. Continue to use a complete keyed `Backend` value for custom
|
|
IDs, authentication, extra request parameters, explicit queue capacity, or
|
|
multiple local endpoints.
|
|
|
|
See the
|
|
[local-endpoint consumer guide](../consumers/pkg-promptkit.md#configure-a-local-openai-compatible-endpoint)
|
|
for task-oriented configuration choices. The
|
|
[`BackendLocal`, `LocalBackend`, and `WithBackend` GoDoc](../../backends.go)
|
|
owns their exact construction, registration, validation, and concurrency
|
|
semantics.
|
|
|
|
## Consumer Action
|
|
|
|
None. Adopt the convenience constructor when it simplifies local endpoint
|
|
configuration.
|