Documentation

StructuredOutputSchema
in package
implements ModelInterface, ArrayAccess, JsonSerializable

StructuredOutputSchema Class Doc Comment

Tags
category

Class

description

JSON output schema for structured content repsonses. This schema dictates the format that an AI should use when responding to your instructions.

author

OpenAPI Generator team

link
https://openapi-generator.tech
implements

\ArrayAccess<string, mixed>

Interfaces, Classes, Traits and Enums

ModelInterface
Interface abstracting model access.
ArrayAccess
JsonSerializable

Table of Contents

DISCRIMINATOR  = null
TYPE__ARRAY  = 'array'
TYPE_BOOLEAN  = 'boolean'
TYPE_INTEGER  = 'integer'
TYPE_NULL  = 'null'
TYPE_NUMBER  = 'number'
TYPE_OBJECT  = 'object'
TYPE_STRING  = 'string'
$attributeMap  : array<string|int, string>
Array of attributes where the key is the local name, and the value is the original name
$container  : array<string|int, mixed>
Associative array for storing property values
$getters  : array<string|int, string>
Array of attributes to getter functions (for serialization of requests)
$openAPIFormats  : array<string|int, string>
Array of property to format mappings. Used for (de)serialization
$openAPIModelName  : string
The original name of the model.
$openAPINullables  : array<string|int, mixed>
Array of nullable properties. Used for (de)serialization
$openAPINullablesSetToNull  : array<string|int, mixed>
If a nullable field gets set to null, insert it here
$openAPITypes  : array<string|int, string>
Array of property to type mappings. Used for (de)serialization
$setters  : array<string|int, string>
Array of attributes to setter functions (for deserialization of responses)
__construct()  : mixed
Constructor
__toString()  : string
Gets the string presentation of the object
attributeMap()  : array<string|int, mixed>
Array of attributes where the key is the local name, and the value is the original name
getAnyOf()  : array<string|int, StructuredOutputSchema>|null
Gets any_of
getDefault()  : object|null
Gets default
getDescription()  : string|null
Gets description
getEnum()  : array<string|int, string>|null
Gets enum
getExample()  : object|null
Gets example
getFormat()  : string|null
Gets format
getItems()  : StructuredOutputSchema|null
Gets items
getMaximum()  : float|null
Gets maximum
getMaxItems()  : int|null
Gets max_items
getMaxLength()  : int|null
Gets max_length
getMaxProperties()  : int|null
Gets max_properties
getMinimum()  : float|null
Gets minimum
getMinItems()  : int|null
Gets min_items
getMinLength()  : int|null
Gets min_length
getMinProperties()  : int|null
Gets min_properties
getModelName()  : string
The original name of the model.
getNullable()  : bool|null
Gets nullable
getPattern()  : string|null
Gets pattern
getProperties()  : array<string, StructuredOutputSchema>|null
Gets properties
getPropertyOrdering()  : array<string|int, string>|null
Gets property_ordering
getRequired()  : array<string|int, string>|null
Gets required
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getTitle()  : string|null
Gets title
getType()  : string|null
Gets type
getTypeAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
isNullable()  : bool
Checks if a property is nullable
isNullableSetToNull()  : bool
Checks if a nullable property is set to null.
jsonSerialize()  : mixed
Serializes the object to a value that can be serialized natively by json_encode().
listInvalidProperties()  : array<string|int, mixed>
Show all the invalid properties with reasons.
offsetExists()  : bool
Returns true if offset exists. False otherwise.
offsetGet()  : mixed|null
Gets offset.
offsetSet()  : void
Sets value based on offset.
offsetUnset()  : void
Unsets offset.
openAPIFormats()  : array<string|int, mixed>
Array of property to format mappings. Used for (de)serialization
openAPITypes()  : array<string|int, mixed>
Array of property to type mappings. Used for (de)serialization
setAnyOf()  : self
Sets any_of
setDefault()  : self
Sets default
setDescription()  : self
Sets description
setEnum()  : self
Sets enum
setExample()  : self
Sets example
setFormat()  : self
Sets format
setItems()  : self
Sets items
setMaximum()  : self
Sets maximum
setMaxItems()  : self
Sets max_items
setMaxLength()  : self
Sets max_length
setMaxProperties()  : self
Sets max_properties
setMinimum()  : self
Sets minimum
setMinItems()  : self
Sets min_items
setMinLength()  : self
Sets min_length
setMinProperties()  : self
Sets min_properties
setNullable()  : self
Sets nullable
setPattern()  : self
Sets pattern
setProperties()  : self
Sets properties
setPropertyOrdering()  : self
Sets property_ordering
setRequired()  : self
Sets required
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setTitle()  : self
Sets title
setType()  : self
Sets type
toHeaderValue()  : string
Gets a header-safe presentation of the object
valid()  : bool
Validate all the properties in the model return true if all passed
openAPINullables()  : array<string|int, mixed>
Array of nullable properties
getOpenAPINullablesSetToNull()  : array<string|int, bool>
Array of nullable field names deliberately set to null
setIfExists()  : void
Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the $this->openAPINullablesSetToNull array
setOpenAPINullablesSetToNull()  : void
Setter - Array of nullable field names deliberately set to null

Constants

Properties

$attributeMap

Array of attributes where the key is the local name, and the value is the original name

protected static array<string|int, string> $attributeMap = ['any_of' => 'anyOf', 'default' => 'default', 'description' => 'description', 'enum' => 'enum', 'example' => 'example', 'format' => 'format', 'items' => 'items', 'max_items' => 'maxItems', 'min_items' => 'minItems', 'max_length' => 'maxLength', 'min_length' => 'minLength', 'pattern' => 'pattern', 'properties' => 'properties', 'property_ordering' => 'propertyOrdering', 'required' => 'required', 'max_properties' => 'maxProperties', 'min_properties' => 'minProperties', 'maximum' => 'maximum', 'minimum' => 'minimum', 'nullable' => 'nullable', 'title' => 'title', 'type' => 'type']

$container

Associative array for storing property values

protected array<string|int, mixed> $container = []

$getters

Array of attributes to getter functions (for serialization of requests)

protected static array<string|int, string> $getters = ['any_of' => 'getAnyOf', 'default' => 'getDefault', 'description' => 'getDescription', 'enum' => 'getEnum', 'example' => 'getExample', 'format' => 'getFormat', 'items' => 'getItems', 'max_items' => 'getMaxItems', 'min_items' => 'getMinItems', 'max_length' => 'getMaxLength', 'min_length' => 'getMinLength', 'pattern' => 'getPattern', 'properties' => 'getProperties', 'property_ordering' => 'getPropertyOrdering', 'required' => 'getRequired', 'max_properties' => 'getMaxProperties', 'min_properties' => 'getMinProperties', 'maximum' => 'getMaximum', 'minimum' => 'getMinimum', 'nullable' => 'getNullable', 'title' => 'getTitle', 'type' => 'getType']

$openAPIFormats

Array of property to format mappings. Used for (de)serialization

protected static array<string|int, string> $openAPIFormats = ['any_of' => null, 'default' => null, 'description' => null, 'enum' => null, 'example' => null, 'format' => null, 'items' => null, 'max_items' => 'int64', 'min_items' => 'int64', 'max_length' => 'int64', 'min_length' => 'int64', 'pattern' => null, 'properties' => null, 'property_ordering' => null, 'required' => null, 'max_properties' => 'int64', 'min_properties' => 'int64', 'maximum' => null, 'minimum' => null, 'nullable' => null, 'title' => null, 'type' => null]
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'StructuredOutputSchema'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['any_of' => true, 'default' => true, 'description' => true, 'enum' => true, 'example' => true, 'format' => true, 'items' => false, 'max_items' => true, 'min_items' => true, 'max_length' => true, 'min_length' => true, 'pattern' => true, 'properties' => true, 'property_ordering' => true, 'required' => true, 'max_properties' => true, 'min_properties' => true, 'maximum' => true, 'minimum' => true, 'nullable' => true, 'title' => true, 'type' => true]

$openAPINullablesSetToNull

If a nullable field gets set to null, insert it here

protected array<string|int, mixed> $openAPINullablesSetToNull = []

$openAPITypes

Array of property to type mappings. Used for (de)serialization

protected static array<string|int, string> $openAPITypes = ['any_of' => '\\MailSlurp\\Models\\StructuredOutputSchema[]', 'default' => 'object', 'description' => 'string', 'enum' => 'string[]', 'example' => 'object', 'format' => 'string', 'items' => '\\MailSlurp\\Models\\StructuredOutputSchema', 'max_items' => 'int', 'min_items' => 'int', 'max_length' => 'int', 'min_length' => 'int', 'pattern' => 'string', 'properties' => 'array<string,\\MailSlurp\\Models\\StructuredOutputSchema>', 'property_ordering' => 'string[]', 'required' => 'string[]', 'max_properties' => 'int', 'min_properties' => 'int', 'maximum' => 'float', 'minimum' => 'float', 'nullable' => 'bool', 'title' => 'string', 'type' => 'string']

$setters

Array of attributes to setter functions (for deserialization of responses)

protected static array<string|int, string> $setters = ['any_of' => 'setAnyOf', 'default' => 'setDefault', 'description' => 'setDescription', 'enum' => 'setEnum', 'example' => 'setExample', 'format' => 'setFormat', 'items' => 'setItems', 'max_items' => 'setMaxItems', 'min_items' => 'setMinItems', 'max_length' => 'setMaxLength', 'min_length' => 'setMinLength', 'pattern' => 'setPattern', 'properties' => 'setProperties', 'property_ordering' => 'setPropertyOrdering', 'required' => 'setRequired', 'max_properties' => 'setMaxProperties', 'min_properties' => 'setMinProperties', 'maximum' => 'setMaximum', 'minimum' => 'setMinimum', 'nullable' => 'setNullable', 'title' => 'setTitle', 'type' => 'setType']

Methods

__construct()

Constructor

public __construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
$data : array<string|int, mixed> = null

Associated array of property values initializing the model

Return values
mixed —

__toString()

Gets the string presentation of the object

public __toString() : string
Return values
string —

attributeMap()

Array of attributes where the key is the local name, and the value is the original name

public static attributeMap() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getDescription()

Gets description

public getDescription() : string|null
Return values
string|null —

getEnum()

Gets enum

public getEnum() : array<string|int, string>|null
Return values
array<string|int, string>|null —

getMaxProperties()

Gets max_properties

public getMaxProperties() : int|null
Return values
int|null —

getMinProperties()

Gets min_properties

public getMinProperties() : int|null
Return values
int|null —

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

getPropertyOrdering()

Gets property_ordering

public getPropertyOrdering() : array<string|int, string>|null
Return values
array<string|int, string>|null —

getRequired()

Gets required

public getRequired() : array<string|int, string>|null
Return values
array<string|int, string>|null —

getters()

Array of attributes to getter functions (for serialization of requests)

public static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getTypeAllowableValues()

Gets allowable values of the enum

public getTypeAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —

isNullable()

Checks if a property is nullable

public static isNullable(string $property) : bool
Parameters
$property : string
Return values
bool —

isNullableSetToNull()

Checks if a nullable property is set to null.

public isNullableSetToNull(string $property) : bool
Parameters
$property : string
Return values
bool —

listInvalidProperties()

Show all the invalid properties with reasons.

public listInvalidProperties() : array<string|int, mixed>
Return values
array<string|int, mixed> —

invalid properties with reasons

offsetExists()

Returns true if offset exists. False otherwise.

public offsetExists(int $offset) : bool
Parameters
$offset : int

Offset

Return values
bool —

offsetGet()

Gets offset.

public offsetGet(int $offset) : mixed|null
Parameters
$offset : int

Offset

Return values
mixed|null —

offsetSet()

Sets value based on offset.

public offsetSet(int|null $offset, mixed $value) : void
Parameters
$offset : int|null

Offset

$value : mixed

Value to be set

Return values
void —

offsetUnset()

Unsets offset.

public offsetUnset(int $offset) : void
Parameters
$offset : int

Offset

Return values
void —

openAPIFormats()

Array of property to format mappings. Used for (de)serialization

public static openAPIFormats() : array<string|int, mixed>
Return values
array<string|int, mixed> —

openAPITypes()

Array of property to type mappings. Used for (de)serialization

public static openAPITypes() : array<string|int, mixed>
Return values
array<string|int, mixed> —

setDefault()

Sets default

public setDefault(object|null $default) : self
Parameters
$default : object|null

default

Return values
self —

setDescription()

Sets description

public setDescription(string|null $description) : self
Parameters
$description : string|null

Provide a description of the schema to help the AI understand the schema.

Return values
self —

setEnum()

Sets enum

public setEnum(array<string|int, string>|null $enum) : self
Parameters
$enum : array<string|int, string>|null

When using type string and format enum pass a collection of enum values here.

Return values
self —

setExample()

Sets example

public setExample(object|null $example) : self
Parameters
$example : object|null

example

Return values
self —

setFormat()

Sets format

public setFormat(string|null $format) : self
Parameters
$format : string|null

Format for string types. Can be null, date-time or enum.

Return values
self —

setMaximum()

Sets maximum

public setMaximum(float|null $maximum) : self
Parameters
$maximum : float|null

maximum

Return values
self —

setMaxItems()

Sets max_items

public setMaxItems(int|null $max_items) : self
Parameters
$max_items : int|null

max_items

Return values
self —

setMaxLength()

Sets max_length

public setMaxLength(int|null $max_length) : self
Parameters
$max_length : int|null

max_length

Return values
self —

setMaxProperties()

Sets max_properties

public setMaxProperties(int|null $max_properties) : self
Parameters
$max_properties : int|null

max_properties

Return values
self —

setMinimum()

Sets minimum

public setMinimum(float|null $minimum) : self
Parameters
$minimum : float|null

minimum

Return values
self —

setMinItems()

Sets min_items

public setMinItems(int|null $min_items) : self
Parameters
$min_items : int|null

min_items

Return values
self —

setMinLength()

Sets min_length

public setMinLength(int|null $min_length) : self
Parameters
$min_length : int|null

min_length

Return values
self —

setMinProperties()

Sets min_properties

public setMinProperties(int|null $min_properties) : self
Parameters
$min_properties : int|null

min_properties

Return values
self —

setNullable()

Sets nullable

public setNullable(bool|null $nullable) : self
Parameters
$nullable : bool|null

nullable

Return values
self —

setPattern()

Sets pattern

public setPattern(string|null $pattern) : self
Parameters
$pattern : string|null

pattern

Return values
self —

setProperties()

Sets properties

public setProperties(array<string, StructuredOutputSchema>|null $properties) : self
Parameters
$properties : array<string, StructuredOutputSchema>|null

Properties of an OBJECT schema. These are key value pairs where the key is the property name and the value is the schema for that property.

Return values
self —

setPropertyOrdering()

Sets property_ordering

public setPropertyOrdering(array<string|int, string>|null $property_ordering) : self
Parameters
$property_ordering : array<string|int, string>|null

Pass an array of property names to specify the order of properties in the generated JSON object if required.

Return values
self —

setRequired()

Sets required

public setRequired(array<string|int, string>|null $required) : self
Parameters
$required : array<string|int, string>|null

required

Return values
self —

setters()

Array of attributes to setter functions (for deserialization of responses)

public static setters() : array<string|int, mixed>
Return values
array<string|int, mixed> —

setTitle()

Sets title

public setTitle(string|null $title) : self
Parameters
$title : string|null

title

Return values
self —

setType()

Sets type

public setType(string|null $type) : self
Parameters
$type : string|null

Primitive JSON schema types with a fallback CUSTOM for unknown values.

Return values
self —

toHeaderValue()

Gets a header-safe presentation of the object

public toHeaderValue() : string
Return values
string —

valid()

Validate all the properties in the model return true if all passed

public valid() : bool
Return values
bool —

True if all properties are valid

openAPINullables()

Array of nullable properties

protected static openAPINullables() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getOpenAPINullablesSetToNull()

Array of nullable field names deliberately set to null

private getOpenAPINullablesSetToNull() : array<string|int, bool>
Return values
array<string|int, bool> —

setIfExists()

Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the $this->openAPINullablesSetToNull array

private setIfExists(string $variableName, array<string|int, mixed> $fields, mixed $defaultValue) : void
Parameters
$variableName : string
$fields : array<string|int, mixed>
$defaultValue : mixed
Return values
void —

setOpenAPINullablesSetToNull()

Setter - Array of nullable field names deliberately set to null

private setOpenAPINullablesSetToNull(array<string|int, bool> $openAPINullablesSetToNull) : void
Parameters
$openAPINullablesSetToNull : array<string|int, bool>
Return values
void —

Search results