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.
Also, ChatGPT has banned below constraint properties. Instead, I'll will
fill the IChatGptSchema.__IAttribute.description property with
the comment text like "@format uuid".
Specified not only by the official documentation, but also by my
experiments. Therefore, its definitions can be inaccurate or be
changed in the future. If you find any wrong or outdated definitions,
please let me know by issue.
Type schema info of the ChatGPT.
IChatGptSchemais a type schema info of the ChatGPT function calling.IChatGptSchemabasically follows the JSON schema definition of the OpenAPI v3.1 speciifcation; OpenApiV3_1.IJsonSchema.However, the
IChatGptSchemadoes not follow the entire specification of the OpenAPI v3.1. It has own specific restrictions and definitions. Here is the list of howIChatGptSchemais different with the OpenAPI v3.1 JSON schema.If compare with the OpenApi.IJsonSchema, the emended JSON schema specification,
falseFor reference, if you've composed the
IChatGptSchematype with the IChatGptSchema.IConfig.referencefalseoption (default isfalse), 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, ChatGPT has banned below constraint properties. Instead, I'll will fill the IChatGptSchema.__IAttribute.description property with the comment text like
"@format uuid".