Type Alias ILlmSchema

Type schema info for LLM (Large Language Model) function calling.

Overview

ILlmSchema is a type schema info for LLM function calling, designed to be compatible with multiple LLM providers while following the JSON schema specification.

Specification

ILlmSchema basically follows the JSON schema definition of the OpenAPI v3.1 specification; OpenApiV3_1.IJsonSchema.

However, it deviates from the standard JSON schema specification and omits many features to ensure compatibility across different LLM providers and their function calling requirements.

Differences from OpenAPI v3.1

Here is the list of how ILlmSchema is different with the OpenAPI v3.1 JSON schema:

• Decompose mixed type: OpenApiV3_1.IJsonSchema.IMixed
• Resolve nullable property: OpenApiV3_1.IJsonSchema.__ISignificant.nullable
• Tuple type is banned: OpenApiV3_1.IJsonSchema.ITuple.prefixItems
• Constant type is banned: OpenApiV3_1.IJsonSchema.IConstant
• Merge OpenApiV3_1.IJsonSchema.IOneOf to ILlmSchema.IAnyOf
• Merge OpenApiV3_1.IJsonSchema.IAllOf to ILlmSchema.IObject
• Merge OpenApiV3_1.IJsonSchema.IRecursiveReference to ILlmSchema.IReference

Differences from OpenApi.IJsonSchema

Compared to OpenApi.IJsonSchema, the emended JSON schema specification:

• ILlmSchema.IAnyOf instead of OpenApi.IJsonSchema.IOneOf
• ILlmSchema.IParameters.$defs instead of OpenApi.IJsonSchema.IComponents.schemas
• Do not support OpenApi.IJsonSchema.ITuple type
• ILlmSchema.properties and ILlmSchema.required are always defined

Strict Mode

When ILlmSchema.IConfig.strict mode is enabled, the schema transformation follows OpenAI's structured output requirements:

• Every ILlmSchema.IObject.additionalProperties is forced to false

• Every property in ILlmSchema.IObject.properties becomes ILlmSchema.IObject.required

• All constraint properties are removed from the schema and moved to IJsonSchemaAttribute.description in a JSDoc-like format:

  • Numeric constraints: minimum, maximum, exclusiveMinimum, exclusiveMaximum, multipleOf
  • String constraints: minLength, maxLength, pattern, format, contentMediaType
  • Array constraints: minItems, maxItems, uniqueItems
  • Example: @minimum 0, @maximum 100, @format uuid