Document shared configuration and repair defaults
This commit is contained in:
8
doc.go
8
doc.go
@@ -1,8 +1,8 @@
|
||||
// Package promptkit provides an embeddable engine for preparing and executing
|
||||
// prompt-defined LLM workflows.
|
||||
//
|
||||
// Applications construct an [Engine] with [NewEngine], select ConfigKit
|
||||
// sources for prompts, profiles, and backends, and
|
||||
// Applications construct an [Engine] with [NewEngine] or register [Configure]
|
||||
// during their own ConfigKit load and pass its result to [NewFromConfig], then
|
||||
// call [Engine.InspectConfiguration], [Engine.InspectPrompt],
|
||||
// [Engine.InspectRequirements], [Engine.InspectProfile], [Engine.InspectBackend],
|
||||
// [Engine.ListProfiles], [Engine.ListPrompts], [Engine.Prepare],
|
||||
@@ -23,8 +23,8 @@
|
||||
// independently. An injected [LLMClient] or [ArtifactReader] can therefore
|
||||
// still receive concurrent calls and must be safe for that use.
|
||||
//
|
||||
// ConfigKit captures the selected configuration when NewEngine constructs an
|
||||
// Engine. Prepare, PrepareExecution, and Run copy request maps, slices, pointer
|
||||
// An Engine captures selected configuration resources during construction.
|
||||
// Prepare, PrepareExecution, and Run copy request maps, slices, pointer
|
||||
// values, and JSON-compatible extra parameters before using them. InspectPrompt,
|
||||
// InspectRequirements, InspectProfile, and InspectBackend return copied
|
||||
// inspection values.
|
||||
|
||||
Reference in New Issue
Block a user