Collection of the named types.
Additional properties information.
The additionalProperties defines the type schema for additional
properties that are not listed in the properties.
By the way, it is not allowed at the parameters level.
OptionaldeprecatedWhether the type is deprecated or not.
OptionaldescriptionDetailed description of the schema.
OptionalexampleExample value.
OptionalexamplesList of example values as key-value pairs.
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 required property keys.
The required contains a list of property keys from properties
that must be provided. Properties not listed in required are optional,
while those listed must be filled.
Below is an example of properties and required:
interface SomeObject {
id: string;
email: string;
name?: string;
}
As you can see, id and email properties are required,
so they are listed in the required array.
{
"type": "object",
"properties": {
"id": { "type": "string" },
"email": { "type": "string" },
"name": { "type": "string" }
},
"required": ["id", "email"]
}
OptionaltitleTitle of the schema.
Discriminator value of the type.
Type for function parameters.
IGeminiSchema.IParametersdefines a function's parameters as a keyword object type, where each property represents a named parameter.It can also be used for structured output metadata to define the expected format of ChatGPT responses.
Reference
https://platform.openai.com/docs/guides/structured-outputs