Go to console

FirebaseVertexAI Framework Reference

Schema

@available(iOS 15.0, macOS 12.0, tvOS 15.0, watchOS 8.0, *)
public final class Schema : Sendable
 
extension Schema: Encodable

A Schema object allows the definition of input and output data types.

These types can be objects, but also primitives and arrays. Represents a select subset of an OpenAPI 3.0 schema object.

  • Modifiers describing the expected format of a string Schema.

    Declaration

    Swift

    @available(iOS 15.0, macOS 12.0, tvOS 15.0, watchOS 8.0, *)
public struct StringFormat : EncodableProtoEnum

  • Modifiers describing the expected format of an integer Schema.

    Declaration

    Swift

    @available(iOS 15.0, macOS 12.0, tvOS 15.0, watchOS 8.0, *)
public struct IntegerFormat : EncodableProtoEnum, Sendable

  • The data type.

    Declaration

    Swift

    public var type: String { get }

  • The format of the data.

    Declaration

    Swift

    public let format: String?

  • A brief description of the parameter.

    Declaration

    Swift

    public let description: String?

  • Indicates if the value may be null.

    Declaration

    Swift

    public let nullable: Bool?

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

    Declaration

    Swift

    public let enumValues: [String]?

  • Schema of the elements of type "ARRAY".

    Declaration

    Swift

    public let items: Schema?

  • Properties of type "OBJECT".

    Declaration

    Swift

    public let properties: [String : Schema]?

  • Required properties of type "OBJECT".

    Declaration

    Swift

    public let requiredProperties: [String]?

  • Returns a Schema representing a string value.

    This schema instructs the model to produce data of type "STRING", which is suitable for decoding into a Swift String (or String?, if nullable is set to true).

    Tip

    If a specific set of string values should be generated by the model (for example, “north”, “south”, “east”, or “west”), use enumeration(values:description:nullable:) instead to constrain the generated values.

    Declaration

    Swift

    public static func string(description: String? = nil, nullable: Bool = false,
                          format: StringFormat? = nil) -> Schema

    Parameters

    description

    An optional description of what the string should contain or represent; may use Markdown format.
    nullable

    If true, instructs the model that it may generate null instead of a string; defaults to false, enforcing that a string value is generated.
    format

    An optional modifier describing the expected format of the string. Currently no formats are officially supported for strings but custom values may be specified using custom(_:), for example .custom("email") or .custom("byte"); these provide additional hints for how the model should respond but are not guaranteed to be adhered to.

  • Returns a Schema representing an enumeration of string values.

    This schema instructs the model to produce data of type "STRING" with the format "enum". This data is suitable for decoding into a Swift String (or String?, if nullable is set to true), or an enum with strings as raw values.

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

    enum Direction: String, Decodable {
  case north, south, east, west
}

    Declaration

    Swift

    public static func enumeration(values: [String], description: String? = nil,
                               nullable: Bool = false) -> Schema

    Parameters

    values

    The list of string values that may be generated by the model.
    description

    An optional description of what the values contain or represent; may use Markdown format.
    nullable

    If true, instructs the model that it may generate null instead of one of the strings specified in values; defaults to false, enforcing that one of the string values is generated.

  • Returns a Schema representing a single-precision floating-point number.

    This schema instructs the model to produce data of type "NUMBER" with the format "float", which is suitable for decoding into a Swift Float (or Float?, if nullable is set to true).

    Important

    This Schema provides a hint to the model that it should generate a single-precision floating-point number, a float, but only guarantees that the value will be a number.

    Declaration

    Swift

    public static func float(description: String? = nil, nullable: Bool = false) -> Schema

    Parameters

    description

    An optional description of what the number should contain or represent; may use Markdown format.
    nullable

    If true, instructs the model that it may generate null instead of a number; defaults to false, enforcing that a number is generated.

  • Returns a Schema representing a floating-point number.

    This schema instructs the model to produce data of type "NUMBER", which is suitable for decoding into a Swift Double (or Double?, if nullable is set to true).

    Declaration

    Swift

    public static func double(description: String? = nil, nullable: Bool = false) -> Schema

    Parameters

    description

    An optional description of what the number should contain or represent; may use Markdown format.
    nullable

    If true, instructs the model that it may return null instead of a number; defaults to false, enforcing that a number is returned.

  • Returns a Schema representing an integer value.

    This schema instructs the model to produce data of type "INTEGER", which is suitable for decoding into a Swift Int (or Int?, if nullable is set to true) or other integer types (such as Int32) based on the expected size of values being generated.

    Important

    If a format of int32 or int64 is specified, this provides a hint to the model that it should generate 32-bit or 64-bit integers but this Schema only guarantees that the value will be an integer. Therefore, it is possible that decoding into an Int32 could overflow even if a format of int32 is specified.

    Declaration

    Swift

    public static func integer(description: String? = nil, nullable: Bool = false,
                           format: IntegerFormat? = nil) -> Schema

    Parameters

    description

    An optional description of what the integer should contain or represent; may use Markdown format.
    nullable

    If true, instructs the model that it may return null instead of an integer; defaults to false, enforcing that an integer is returned.
    format

    An optional modifier describing the expected format of the integer. Currently the formats int32 and int64 are supported; custom values may be specified using custom(_:) but may be ignored by the model.

  • Returns a Schema representing a boolean value.

    This schema instructs the model to produce data of type "BOOLEAN", which is suitable for decoding into a Swift Bool (or Bool?, if nullable is set to true).

    Declaration

    Swift

    public static func boolean(description: String? = nil, nullable: Bool = false) -> Schema

    Parameters

    description

    An optional description of what the boolean should contain or represent; may use Markdown format.
    nullable

    If true, instructs the model that it may return null instead of a boolean; defaults to false, enforcing that a boolean is returned.

  • Returns a Schema representing an array.

    This schema instructs the model to produce data of type "ARRAY", which has elements of any other data type (including nested "ARRAY"s). This data is suitable for decoding into many Swift collection types, including Array, holding elements of types suitable for decoding from the respective items type.

    Declaration

    Swift

    public static func array(items: Schema, description: String? = nil,
                         nullable: Bool = false) -> Schema

    Parameters

    items

    The Schema of the elements that the array will hold.
    description

    An optional description of what the array should contain or represent; may use Markdown format.
    nullable

    If true, instructs the model that it may return null instead of an array; defaults to false, enforcing that an array is returned.

  • Returns a Schema 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 is suitable for decoding into Swift keyed collection types, including Dictionary, or other custom struct or class types.

    Example: A City could be represented with the following object Schema.

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

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

    struct City: Decodable {
  let name: String
  let population: Int
}

    Declaration

    Swift

    public static func object(properties: [String: Schema], optionalProperties: [String] = [],
                          description: String? = nil, nullable: Bool = false) -> Schema

    Parameters

    properties

    A dictionary containing the object’s property names as keys and their respective Schemas as values.
    optionalProperties

    A list of property names that may be be omitted in objects generated by the model; these names must correspond to the keys provided in the properties dictionary and may be an empty list.
    description

    An optional description of what the object should contain or represent; may use Markdown format.
    nullable

    If true, instructs the model that it may return null instead of an object; defaults to false, enforcing that an object is returned.