Interface IObject

Additional properties' info.

The additionalProperties means the type schema info of the additional properties that are not listed in the properties.

By the way, if you've configured IChatGptSchema.IConfig.strict as true, ChatGPT function calling does not support such dynamic key typed properties, so the additionalProperties becomes always false.

Properties of the object.

The properties means a list of key-value pairs of the object's regular properties. The key is the name of the regular property, and the value is the type schema info.

List of key values of the required properties.

The required means a list of the key values of the required properties. If some property key is not listed in the required list, it means that property is optional. Otherwise some property key exists in the required list, it means that the property must be filled.

Below is an example of the properties and required.

interface SomeObject {
  id: string;
  email: string;
  name?: string;
}
Copy

As you can see, id and email properties are required, so that they are listed in the required list.

{
  "type": "object",
  "properties": {
    "id": { "type": "string" },
    "email": { "type": "string" },
    "name": { "type": "string" }
  },
  "required": ["id", "email"]
}
Copy