AIConfig

AIConfig that is used to store generative AI prompts, models and model parameters

Type object
File match aiconfig.json aiconfig.jsonc *.aiconfig.json *.aiconfig.jsonc aiconfig.yml aiconfig.yaml *.aiconfig.yml *.aiconfig.yaml
Schema URL https://catalog.lintel.tools/schemas/schemastore/aiconfig/latest.json
Source https://www.schemastore.org/aiconfig-1.0.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

name string required

Friendly name descriptor for the AIConfig. Could default to the filename if not specified.

schema_version object | string required
metadata Record<string, any> required

Root-level metadata that applies to the entire AIConfig.

4 nested properties
parameters Record<string, any>

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.

models Record<string, 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.

default_model string

Default model to use for prompts that do not specify a model.

model_parsers Record<string, string>

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.

prompts object[] required

Array of prompts that make up the AIConfig.

description string

Description of the AIConfig. If you have a collection of different AIConfigs, this may be used for dynamic prompt routing.

Definitions

SchemaVersion object | string
PromptInput object | string
Attachment object

Data of specified MIME type to attach to a prompt

data required

Data representing the attachment

mime_type string

MIME type of the attachment. If not specified, the MIME type will be assumed to be text/plain.

metadata Record<string, any>

Attachment metadata.

Output object | object

Model inference result.