Type Alias IChatGptSchema

Type schema info of the ChatGPT.

IChatGptSchema is a type schema info of the ChatGPT function calling.

IChatGptSchema basically follows the JSON schema definition of the OpenAPI v3.1 speciifcation; OpenApiV3_1.IJsonSchema.

However, the IChatGptSchema does not follow the entire specification of the OpenAPI v3.1. It has own specific restrictions and definitions. Here is the list of how IChatGptSchema 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 IChatGptSchema.IAnOf
• Merge OpenApiV3_1.IJsonSchema.IAllOf to IChatGptSchema.IObject
• Merge OpenApiV3_1.IJsonSchema.IRecursiveReference to IChatGptSchema.IReference
• When IChatGptSchema.IConfig.strict mode
  • Every object properties must be required
  • Do not allow IChatGptSchema.IObject.additionalProperties

If compare with the OpenApi.IJsonSchema, the emended JSON schema specification,

• IChatGptSchema.IAnyOf instead of the OpenApi.IJsonSchema.IOneOf
• IChatGptSchema.IParameters.$defs instead of the OpenApi.IJsonSchema.IComponents.schemas
• IChatGptSchema.IString.enum instead of the OpenApi.IJsonSchema.IConstant
• IChatGptSchema.additionalProperties is fixed to false
• No tuple type OpenApi.IJsonSchema.ITuple support
• When IChatGptSchema.IConfig.strict mode
  • Every object properties must be required
  • Do not allow IChatGptSchema.IObject.additionalProperties

For reference, if you've composed the IChatGptSchema type with the IChatGptSchema.IConfig.reference false option (default is false), only the recursived named types would be archived into the IChatGptSchema.IParameters.$defs, and the others would be ecaped from the IChatGptSchema.IReference type.

Also, OpenAI has banned below constraint properties. Instead, IChatGptSchema fills the IChatGptSchema.__IAttribute.description property with the comment text like "@format uuid".

• OpenApi.IJsonSchema.INumber.minimum
• OpenApi.IJsonSchema.INumber.maximum
• OpenApi.IJsonSchema.INumber.multipleOf
• OpenApi.IJsonSchema.IString.minLength
• OpenApi.IJsonSchema.IString.maxLength
• OpenApi.IJsonSchema.IString.format
• OpenApi.IJsonSchema.IString.pattern
• OpenApi.IJsonSchema.IString.contentMediaType
• OpenApi.IJsonSchema.IString.default
• OpenApi.IJsonSchema.IArray.minItems
• OpenApi.IJsonSchema.IArray.maxItems
• OpenApi.IJsonSchema.IArray.unique

Additionally, OpenAI cannot define the description property to the IChatGptSchema.IReference type, and even does not understand the capsulization to the IChatGptSchema.IAnyOf type. Therefore, the description is written to the parent object type, not the reference type.

{
  "type": "object",
  "description": "### Description of {@link something} property.\n\n> Hello?",
  "properties": {
    "something": {
      "$ref": "#/$defs/SomeObject"
    }
  }
}
Copy