Object type schema info.

interface IObject {
    deprecated?: boolean;
    description?: string;
    example?: any;
    examples?: Record<string, any>;
    nullable?: boolean;
    properties: Record<string, IGeminiSchema>;
    required: string[];
    type: "object";
}

Hierarchy (View Summary)

Properties

deprecated?: boolean

Whether the type is deprecated or not.

document of Gemini says not supported, but cannot sure

description?: string

Detailed description of the schema.

example?: any

Example value.

document of Gemini says not supported, but cannot sure

examples?: Record<string, any>

List of example values as key-value pairs.

document of Gemini says not supported, but cannot sure

nullable?: boolean

Whether to allow null value or not.

properties: Record<string, IGeminiSchema>

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.

If you need additional properties that is represented by dynamic key, it is not possible to compose because the Gemini does not support it.

required: string[]

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;
}

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"]
}
type: "object"

Discriminator value of the type.