AIConfig
AIConfig that is used to store generative AI prompts, models and model parameters
aiconfig.jsonaiconfig.jsonc*.aiconfig.json*.aiconfig.jsoncaiconfig.ymlaiconfig.yaml*.aiconfig.yml*.aiconfig.yaml
Validate
Check your file against this schema
Opens the validator with this schema already loaded. Paste your
aiconfig.json and it validates in your browser — nothing is uploaded.
Reference
Fields
Generated directly from the schema, following local
$refs, to two levels of nesting.
| Field | Type | Description |
|---|---|---|
namerequired | string | Friendly name descriptor for the AIConfig. Could default to the filename if not specified. |
description | string | Description of the AIConfig. If you have a collection of different AIConfigs, this may be used for dynamic prompt routing. |
schema_versionrequired | anyOf | — |
metadatarequired | object | Root-level metadata that applies to the entire AIConfig. |
metadata.parameters | object | Parameter definitions that are accessible to all prompts in this AIConfig. These parameters can be referenced in the prompts using {{param_name}} handlebars syntax. For more information, see https://handlebarsjs.com/guide/#basic-usage. |
metadata.models | object | Globally defined model settings. Any prompts that use these models will have these settings applied by default, unless they override them with their own model settings. |
metadata.default_model | string | Default model to use for prompts that do not specify a model. |
metadata.model_parsers | object | Model ID to ModelParser ID mapping. This is useful if you want to use a custom ModelParser for a model, or if a single ModelParser can handle multiple models. |
promptsrequired | array<object> | Array of prompts that make up the AIConfig. |
Audit
What we found in this schema
- Declared draft: draft-07
- Validates cleanly against its own meta-schema.
- 34 properties, 91% carrying a description, max nesting depth 12.
Standards
Specification sections for the keywords in this schema
| Keyword | Document | Section |
|---|---|---|
$id | JSON Schema Core, draft 2020-12 | §8.2.1 — The "$id" Keyword |
$ref | JSON Schema Core, draft 2020-12 | §8.2.3.1 — Direct References with "$ref" |
$schema | JSON Schema Core, draft 2020-12 | §8.1.1 — "$schema" |
additionalProperties | JSON Schema Core, draft 2020-12 | §10.3.2.3 — "additionalProperties" |
anyOf | JSON Schema Core, draft 2020-12 | §10.2.1.2 — "anyOf" |
const | JSON Schema Validation, draft 2020-12 | §6.1.3 — "const" |
description | JSON Schema Validation, draft 2020-12 | §9.1 — "title" and "description" |
enum | JSON Schema Validation, draft 2020-12 | §6.1.2 — "enum" |
items | JSON Schema Core, draft 2020-12 | §10.3.1.2 — "items" |
properties | JSON Schema Core, draft 2020-12 | §10.3.2.1 — "properties" |
required | JSON Schema Validation, draft 2020-12 | §6.5.3 — "required" |
type | JSON Schema Validation, draft 2020-12 | §6.1.1 — "type" |
Documents
- JSON Schema Core, draft 2020-12 — JSON Schema: A Media Type for Describing JSON Documents, A. Wright, H. Andrews, B. Hutton, G. Dennis, Eds., 2022. draft-bhutton-json-schema-01. An expired Internet-Draft with no formal standing in the IETF standards process; it is nonetheless the specification of record for JSON Schema 2020-12, published by json-schema.org.
- JSON Schema Validation, draft 2020-12 — JSON Schema Validation: A Vocabulary for Structural Validation of JSON, A. Wright, H. Andrews, B. Hutton, Eds., 2022.
- RFC 8259 (STD 90) — The JavaScript Object Notation (JSON) Data Interchange Format, T. Bray, Ed., 2017. The format a schema describes.
- RFC 6901 — JavaScript Object Notation (JSON) Pointer. Defines the pointer syntax used by $ref fragments and the ~0 / ~1 escapes.
Source
Attribution
This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.