Document prompt-owned schemas and finalize migration
This commit is contained in:
@@ -201,11 +201,19 @@ messages; the integration contract defines its wire representation.
|
||||
| --- | --- | --- |
|
||||
| `format` | yes | `text`, `markdown`, or `json` |
|
||||
| `validation_mode` | yes | `none`, `basic`, `json`, or `json_schema` |
|
||||
| `schema_path` | for `json_schema` | Path in the selected schema source |
|
||||
| `schema` | one selection for `json_schema` | Inline JSON Schema value |
|
||||
| `schema_file` | one selection for `json_schema` | File relative to the contributing field's source context |
|
||||
| `schema_path` | one selection for `json_schema` | Path within the applicable explicit schema root |
|
||||
| `repair_attempts` | no | Integer 0–3; default 0. Positive values need `basic`, `json`, or `json_schema` |
|
||||
|
||||
`none` skips content validation; `basic` requires nonempty content; `json`
|
||||
accepts any valid JSON value; `json_schema` checks the selected schema.
|
||||
In `json_schema` mode exactly one nonnull `schema`, `schema_file`, or
|
||||
`schema_path` must be selected. Null clears a selection; `false`, `true`, and
|
||||
`{}` are values. Blank references are invalid. Other modes ignore these fields
|
||||
for schema selection and loading. ConfigKit composes inline mappings normally;
|
||||
switching forms can require explicitly clearing an inherited alternative.
|
||||
Replacing an identified prompt record replaces its complete earlier record.
|
||||
`format` determines output artifact metadata. JSON Schema mode also supplies
|
||||
structured-output metadata to compatible clients. Plain `json` does not
|
||||
request a provider-native JSON-object constraint. A positive repair budget
|
||||
@@ -433,14 +441,31 @@ generic inheritance and layer mechanics, consult
|
||||
|
||||
## Schemas
|
||||
|
||||
Schemas are JSON documents selected by a prompt or request `schema_path`.
|
||||
Directory and `fs.FS` schema paths resolve within the configured root. Each
|
||||
schema must be self-contained: in-document references, IDs, and anchors are
|
||||
Schemas can be inline, source-relative files, or files under an explicit root.
|
||||
An optional `schema_root` may be set at the application root and in each
|
||||
collection. A collection's nonnull root takes precedence over the application
|
||||
root for its prompts; an absent or null collection root falls back to the
|
||||
application root. A nonnull blank root is invalid. There is no implicit
|
||||
working-directory root. Roots and `schema_file` references resolve using the
|
||||
effective field's contributing ConfigKit filesystem and base directory;
|
||||
missing usable context is a configuration error. An explicit `.` is valid
|
||||
with usable context. A `schema_path` requires an applicable root. Root choice
|
||||
is made before reading: a missing file never triggers another-root search.
|
||||
Schema selection and context are captured during construction without reading
|
||||
schema files. Files are read and compiled during preparation; a missing,
|
||||
malformed, or unresolvable file is an operational validation error. Inline
|
||||
configuration values follow native ConfigKit composition and null handling.
|
||||
For request-level replacement, inline `Schema` needs no root and `SchemaPath`
|
||||
uses the selected prompt's applicable root. A replacement does not inherit the
|
||||
configured schema selection or `schema_file` context.
|
||||
Runtime inline values are encoded as JSON before preparation; file-backed JSON
|
||||
uses the existing number-preserving decoder. No additional numerical equivalence
|
||||
between input representations is implied.
|
||||
|
||||
Each schema must be self-contained: in-document references, IDs, and anchors are
|
||||
supported, but references requiring another file or network resource fail.
|
||||
References must also work without the source filename as a base; use fragment
|
||||
references or explicit schema IDs rather than relying on that filename.
|
||||
`WithSchemaFile` exposes one schema under its base name. An unreadable,
|
||||
invalid, or unresolvable schema causes an operational validation error.
|
||||
Valid JSON that fails the schema instead yields a failed validation result.
|
||||
Schema documents are detached without applying the provider extra-parameter
|
||||
copy limits; this does not change the schema decoder, compiler, or
|
||||
|
||||
Reference in New Issue
Block a user