Finalize conversation and execution group documentation
This commit is contained in:
9
doc.go
9
doc.go
@@ -6,7 +6,10 @@
|
||||
// call [Engine.InspectConfiguration], [Engine.InspectPrompt],
|
||||
// [Engine.InspectRequirements], [Engine.InspectProfile], [Engine.InspectBackend],
|
||||
// [Engine.ListProfiles], [Engine.ListPrompts], [Engine.Prepare],
|
||||
// [Engine.PrepareExecution], [Engine.Run], or [Engine.RunPrepared]. Concrete registries, repositories,
|
||||
// [Engine.PrepareExecution], [Engine.Run], [Engine.RunPrepared], or
|
||||
// [Engine.Coordinate]. Captured [Exchange] values support independent
|
||||
// continuations, and [ExecutionGroup] collects explicitly observed runs.
|
||||
// Concrete registries, repositories,
|
||||
// validators, and the built-in OpenAI-compatible client remain internal
|
||||
// implementation details.
|
||||
//
|
||||
@@ -14,7 +17,7 @@
|
||||
//
|
||||
// An Engine supports concurrent InspectConfiguration, InspectPrompt,
|
||||
// InspectRequirements, InspectProfile, InspectBackend, ListProfiles, ListPrompts,
|
||||
// Prepare, PrepareExecution, Run, and RunPrepared calls. Engine-local backend policies
|
||||
// Prepare, PrepareExecution, Run, RunPrepared, and Coordinate calls. Engine-local backend policies
|
||||
// bound admitted Run and RunPrepared calls and model generations where
|
||||
// configured, while different backend pools and unlimited backends continue
|
||||
// independently. An injected [LLMClient] or [ArtifactReader] can therefore
|
||||
@@ -43,7 +46,7 @@
|
||||
// that enforces their filesystem, authorization, and size policies.
|
||||
//
|
||||
// Rendered messages, input and output [Artifact] bodies, [RunResult.RawOutput],
|
||||
// and [ValidationResult.Errors] may contain sensitive data. Credential
|
||||
// [ValidationResult.Errors], and [ExchangeDetails.Messages] may contain sensitive data. Credential
|
||||
// exclusion and redaction do not sanitize those values. Applications and
|
||||
// injected collaborators are responsible for access control, retention,
|
||||
// logging, and secret handling appropriate to their data.
|
||||
|
||||
Reference in New Issue
Block a user