gemini4kt/io.github.ugaikit.gemini4kt/Schema

Schema

@Serializable

data class Schema(val type: String, val format: String? = null, val description: String? = null, val nullable: Boolean = false, val enum: List<String> = emptyList(), val properties: Map<String, Schema> = emptyMap(), val required: List<String> = emptyList(), val items: Schema? = null)

Represents the schema definition for a data model, detailing its structure, type, and various constraints.

Constructors

Schema

constructor(type: String, format: String? = null, description: String? = null, nullable: Boolean = false, enum: List<String> = emptyList(), properties: Map<String, Schema> = emptyMap(), required: List<String> = emptyList(), items: Schema? = null)

Properties

description

val description: String? = null

A human-readable description of the schema, explaining its purpose and usage.

enum

val enum: List<String>

A list of acceptable values for this schema if it represents an enumeration type.

format

val format: String? = null

Additional formatting information for the data type, providing more precise definition (e.g., "date-time" for string type).

items

val items: Schema? = null

The schema for items in an array, applicable when the type is "array". Defines the schema of elements within the array.

nullable

val nullable: Boolean = false

Indicates whether the value can be null.

properties

val properties: Map<String, Schema>

A map of property names to their respective schemas, defining the structure of an object type. Each entry represents a field and its schema.

required

val required: List<String>

A list of property names that are required for this schema, ensuring certain fields must be present in the data.

type

val type: String

The primary type of data this schema represents (e.g., "string", "integer", "object").