Clarify resource inspection documentation

doc.go

@@ -4,17 +4,17 @@
 // Applications construct an [Engine] with [NewEngine], select ConfigKit
 // sources for prompts, profiles, and backends, and
 // call [Engine.InspectConfiguration], [Engine.InspectPrompt],
-// [Engine.InspectRequirements], [Engine.InspectProfile], [Engine.ListProfiles],
-// [Engine.ListPrompts], [Engine.Prepare], [Engine.PrepareExecution],
-// [Engine.Run], or [Engine.RunPrepared]. Concrete registries, repositories,
+// [Engine.InspectRequirements], [Engine.InspectProfile], [Engine.InspectBackend],
+// [Engine.ListProfiles], [Engine.ListPrompts], [Engine.Prepare],
+// [Engine.PrepareExecution], [Engine.Run], or [Engine.RunPrepared]. Concrete registries, repositories,
 // validators, and the built-in OpenAI-compatible client remain internal
 // implementation details.
 //
 // # Concurrency and ownership
 //
 // An Engine supports concurrent InspectConfiguration, InspectPrompt,
-// InspectRequirements, InspectProfile, ListProfiles, ListPrompts, Prepare,
-// PrepareExecution, Run, and RunPrepared calls. Engine-local backend policies
+// InspectRequirements, InspectProfile, InspectBackend, ListProfiles, ListPrompts,
+// Prepare, PrepareExecution, Run, and RunPrepared 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
@@ -23,7 +23,8 @@
 // ConfigKit captures the selected configuration when NewEngine constructs an
 // Engine. Prepare, PrepareExecution, and Run copy request maps, slices, pointer
 // values, and JSON-compatible extra parameters before using them. InspectPrompt,
-// InspectRequirements, and InspectProfile return copied inspection values.
+// InspectRequirements, InspectProfile, and InspectBackend return copied
+// inspection values.
 // ListProfiles and ListPrompts return caller-owned identity slices.
 // Returned values and values passed to extension interfaces are likewise
 // isolated from engine state.
@@ -56,17 +57,22 @@
 // [GenerateResponse], [ExecutionTargetPresence], and the string value types
 // used by those values.
 //
-// Construction, inspection, handle, and error values, including [Config],
+// Resource inspection results support direct JSON and YAML encoding.
+// [PromptInspection], [ProfileInspection], [BackendInspection], and their nested
+// values define field names, nesting, and omission of absent optional fields.
+// Formatting belongs to the selected encoder.
+//
+// Other construction, inspection, handle, and error values, including [Config],
 // [ConfigurationSources], [ConfigurationInspection], [BackendConfig],
 // [ProfileConfig], [RunRequest],
-// [ArtifactRef], [ExecutionTargetOverride], [ProfileInspection],
-// [PromptIdentity], [PromptInputDefinition], [PromptInspection],
+// [ArtifactRef], [ExecutionTargetOverride],
+// [PromptIdentity], [PromptInputDefinition],
 // [RequirementInspectionRequest], [RequirementInspection], [PreparedExecution],
 // [CapacityError], [GenerationError], [RetryExhaustedError], and
 // [ExecutionEvent], do not have stable JSON
 // representations. Direct API keys are nevertheless excluded from JSON for
 // every public value.
-
+//
 // Provider-derived [GenerationError] accessor values are untrusted and can
 // contain sensitive request or schema fragments. Applications must apply their
 // own disclosure policy before logging, displaying, or returning them.