Modifiers describing the expected format of a stringSchema.

Declaration

@available(iOS15.0,macOS12.0,tvOS15.0,watchOS8.0,*)publicstructStringFormat:EncodableProtoEnum

Modifiers describing the expected format of an integerSchema.

Declaration

@available(iOS15.0,macOS12.0,tvOS15.0,watchOS8.0,*)publicstructIntegerFormat:EncodableProtoEnum,Sendable

The data type.

Declaration

publicvartype:String{get}

The format of the data.

Declaration

publicletformat:String?

A human-readable explanation of the purpose of the schema or property. While not strictlyenforced on the value itself, good descriptions significantly help the model understand thecontext and generate more relevant and accurate output.

Declaration

publicletdescription:String?

A human-readable name/summary for the schema or a specific property. This helps document theschema’s purpose but doesn’t typically constrain the generated value. It can subtly guide themodel by clarifying the intent of a field.

Declaration

publiclettitle:String?

Indicates if the value may be null.

Declaration

publicletnullable:Bool?

Possible values of the element of type “STRING” with “enum” format.

Declaration

publicletenumValues:[String]?

Defines the schema for the elements within the"ARRAY". All items in the generated arraymust conform to this schema definition. This can be a simple type (like .string) or a complexnested object schema.

Declaration

publicletitems:Schema?

An integer specifying the minimum number of items the generated"ARRAY" must contain.

Declaration

publicletminItems:Int?

An integer specifying the maximum number of items the generated"ARRAY" must contain.

Declaration

publicletmaxItems:Int?

The minimum value of a numeric type.

Declaration

publicletminimum:Double?

The maximum value of a numeric type.

Declaration

publicletmaximum:Double?

Defines the members (key-value pairs) expected within an object. It’s a dictionary where keysare the property names (strings) and values are nestedSchema definitions describing eachproperty’s type and constraints.

Declaration

publicletproperties:[String:Schema]?

An array ofSchema objects. The generated data must be valid againstany (one or more)of the schemas listed in this array. This allows specifying multiple possible structures ortypes for a single field.

For example, a value could be either aString or anInteger:

Schema.anyOf(schemas:[.string(),.integer()])

Declaration

publicletanyOf:[Schema]?

An array of strings, where each string is the name of a property defined in thepropertiesdictionary that must be present in the generated object. If a property is listed here, themodel must include it in the output.

Declaration

publicletrequiredProperties:[String]?

A specific hint provided to the Gemini model, suggesting the order in which the keys shouldappear in the generated JSON string. Important: Standard JSON objects are inherently unorderedcollections of key-value pairs. While the model will try to respect propertyOrdering in itstextual JSON output, subsequent parsing into native Swift objects (like Dictionaries orStructs) might not preserve this order. This parameter primarily affects the raw JSON stringserialization.

Declaration

publicletpropertyOrdering:[String]?

Returns aSchema representing a string value.

This schema instructs the model to produce data of type"STRING", which is suitable fordecoding into a SwiftString (orString?, ifnullable is set totrue).

Declaration

publicstaticfuncstring(description:String?=nil,nullable:Bool=false,format:StringFormat?=nil)->Schema

Parameters

Returns aSchema representing an enumeration of string values.

This schema instructs the model to produce data of type"STRING" with theformat"enum".This data is suitable for decoding into a SwiftString (orString?, ifnullable is settotrue), or anenum with strings as raw values.

Example:The values["north", "south", "east", "west"] for an enumeration of directions.

enumDirection:String,Decodable{casenorth,south,east,west}

Declaration

publicstaticfuncenumeration(values:[String],description:String?=nil,nullable:Bool=false)->Schema

Parameters

Returns aSchema representing a single-precision floating-point number.

This schema instructs the model to produce data of type"NUMBER" with theformat"float", which is suitable for decoding into a SwiftFloat (orFloat?, ifnullable isset totrue).

Declaration

publicstaticfuncfloat(description:String?=nil,nullable:Bool=false,minimum:Float?=nil,maximum:Float?=nil)->Schema

Parameters

Returns aSchema representing a floating-point number.

This schema instructs the model to produce data of type"NUMBER", which is suitable fordecoding into a SwiftDouble (orDouble?, ifnullable is set totrue).

Declaration

publicstaticfuncdouble(description:String?=nil,nullable:Bool=false,minimum:Double?=nil,maximum:Double?=nil)->Schema

Parameters

Returns aSchema representing an integer value.

This schema instructs the model to produce data of type"INTEGER", which is suitable fordecoding into a SwiftInt (orInt?, ifnullable is set totrue) or other integer types(such asInt32) based on the expected size of values being generated.

Declaration

publicstaticfuncinteger(description:String?=nil,nullable:Bool=false,format:IntegerFormat?=nil,minimum:Int?=nil,maximum:Int?=nil)->Schema

Parameters

Returns aSchema representing a boolean value.

This schema instructs the model to produce data of type"BOOLEAN", which is suitable fordecoding into a SwiftBool (orBool?, ifnullable is set totrue).

Declaration

publicstaticfuncboolean(description:String?=nil,nullable:Bool=false)->Schema

Parameters

Returns aSchema representing an array.

This schema instructs the model to produce data of type"ARRAY", which has elements of anyother data type (including nested"ARRAY"s). This data is suitable for decoding into manySwift collection types, includingArray, holding elements of types suitable for decodingfrom the respectiveitems type.

Declaration

publicstaticfuncarray(items:Schema,description:String?=nil,nullable:Bool=false,minItems:Int?=nil,maxItems:Int?=nil)->Schema

Parameters

Returns aSchema representing an object.

This schema instructs the model to produce data of type"OBJECT", which has keys of type"STRING" and values of any other data type (including nested"OBJECT"s). This data issuitable for decoding into Swift keyed collection types, includingDictionary, or othercustomstruct orclass types.

Example: ACity could be represented with the following objectSchema.

Schema.object(properties:["name":.string(),"population":.integer()])

The generated data could be decoded into a Swift native type:

structCity:Decodable{letname:Stringletpopulation:Int}

Declaration

publicstaticfuncobject(properties:[String:Schema],optionalProperties:[String]=[],propertyOrdering:[String]?=nil,description:String?=nil,title:String?=nil,nullable:Bool=false)->Schema

Parameters

Returns aSchema representing a value that must conform toany (one or more) of theprovided sub-schemas.

This schema instructs the model to produce data that is valid against at least one of theschemas listed in theschemas array. This is useful when a field can accept multipledistinct types or structures.

Example: A field that can hold either a simple user ID (integer) or a detailed userobject.

Schema.anyOf(schemas:[.integer(description:"User ID"),.object(properties:["userId":.integer(),"userName":.string()],description:"Detailed User Object")])

The generated data could be decoded based on which schema it matches.

Declaration

publicstaticfuncanyOf(schemas:[Schema])->Schema

Parameters