Class StructuredOutputSchema

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

Inheritance

object

StructuredOutputSchema

Implements

IValidatableObject

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: mailslurp.Model

Assembly: mailslurp.dll

Syntax

[DataContract(Name = "StructuredOutputSchema")]
public class StructuredOutputSchema : IValidatableObject

Constructors

View Source

StructuredOutputSchema(List<StructuredOutputSchema>, object, string, List<string>, object, string, StructuredOutputSchema, long?, long?, long?, long?, string, Dictionary<string, StructuredOutputSchema>, List<string>, List<string>, long?, long?, decimal?, decimal?, bool?, string, TypeEnum?)

Initializes a new instance of the StructuredOutputSchema class.

Declaration

public StructuredOutputSchema(List<StructuredOutputSchema> anyOf = null, object varDefault = null, string description = null, List<string> varEnum = null, object example = null, string format = null, StructuredOutputSchema items = null, long? maxItems = null, long? minItems = null, long? maxLength = null, long? minLength = null, string pattern = null, Dictionary<string, StructuredOutputSchema> properties = null, List<string> propertyOrdering = null, List<string> required = null, long? maxProperties = null, long? minProperties = null, decimal? maximum = null, decimal? minimum = null, bool? nullable = null, string title = null, StructuredOutputSchema.TypeEnum? type = null)

Parameters

Type	Name	Description
List<StructuredOutputSchema>	anyOf	anyOf.
object	varDefault	varDefault.
string	description	Provide a description of the schema to help the AI understand the schema..
List<string>	varEnum	When using type string and format enum pass a collection of enum values here..
object	example	example.
string	format	Format for string types. Can be null, date-time or enum..
StructuredOutputSchema	items	items.
long?	maxItems	maxItems.
long?	minItems	minItems.
long?	maxLength	maxLength.
long?	minLength	minLength.
string	pattern	pattern.
Dictionary<string, StructuredOutputSchema>	properties	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..
List<string>	propertyOrdering	Pass an array of property names to specify the order of properties in the generated JSON object if required..
List<string>	required	required.
long?	maxProperties	maxProperties.
long?	minProperties	minProperties.
decimal?	maximum	maximum.
decimal?	minimum	minimum.
bool?	nullable	nullable.
string	title	title.
StructuredOutputSchema.TypeEnum?	type	Primitive JSON schema types with a fallback CUSTOM for unknown values..

Properties

View Source

AnyOf

Gets or Sets AnyOf

Declaration

[DataMember(Name = "anyOf", EmitDefaultValue = true)]
public List<StructuredOutputSchema> AnyOf { get; set; }

Property Value

Type	Description
List<StructuredOutputSchema>

View Source

Default

Gets or Sets Default

Declaration

[DataMember(Name = "default", EmitDefaultValue = true)]
public object Default { get; set; }

Property Value

Type	Description
object

View Source

Description

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

Declaration

[DataMember(Name = "description", EmitDefaultValue = true)]
public string Description { get; set; }

Property Value

Type	Description
string	Provide a description of the schema to help the AI understand the schema.

View Source

Enum

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

Declaration

[DataMember(Name = "enum", EmitDefaultValue = true)]
public List<string> Enum { get; set; }

Property Value

Type	Description
List<string>	When using type string and format enum pass a collection of enum values here.

View Source

Example

Gets or Sets Example

Declaration

[DataMember(Name = "example", EmitDefaultValue = true)]
public object Example { get; set; }

Property Value

Type	Description
object

View Source

Format

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

Declaration

[DataMember(Name = "format", EmitDefaultValue = true)]
public string Format { get; set; }

Property Value

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

View Source

Items

Gets or Sets Items

Declaration

[DataMember(Name = "items", EmitDefaultValue = false)]
public StructuredOutputSchema Items { get; set; }

Property Value

Type	Description
StructuredOutputSchema

View Source

MaxItems

Gets or Sets MaxItems

Declaration

[DataMember(Name = "maxItems", EmitDefaultValue = true)]
public long? MaxItems { get; set; }

Property Value

Type	Description
long?

View Source

MaxLength

Gets or Sets MaxLength

Declaration

[DataMember(Name = "maxLength", EmitDefaultValue = true)]
public long? MaxLength { get; set; }

Property Value

Type	Description
long?

View Source

MaxProperties

Gets or Sets MaxProperties

Declaration

[DataMember(Name = "maxProperties", EmitDefaultValue = true)]
public long? MaxProperties { get; set; }

Property Value

Type	Description
long?

View Source

Maximum

Gets or Sets Maximum

Declaration

[DataMember(Name = "maximum", EmitDefaultValue = true)]
public decimal? Maximum { get; set; }

Property Value

Type	Description
decimal?

View Source

MinItems

Gets or Sets MinItems

Declaration

[DataMember(Name = "minItems", EmitDefaultValue = true)]
public long? MinItems { get; set; }

Property Value

Type	Description
long?

View Source

MinLength

Gets or Sets MinLength

Declaration

[DataMember(Name = "minLength", EmitDefaultValue = true)]
public long? MinLength { get; set; }

Property Value

Type	Description
long?

View Source

MinProperties

Gets or Sets MinProperties

Declaration

[DataMember(Name = "minProperties", EmitDefaultValue = true)]
public long? MinProperties { get; set; }

Property Value

Type	Description
long?

View Source

Minimum

Gets or Sets Minimum

Declaration

[DataMember(Name = "minimum", EmitDefaultValue = true)]
public decimal? Minimum { get; set; }

Property Value

Type	Description
decimal?

View Source

Nullable

Gets or Sets Nullable

Declaration

[DataMember(Name = "nullable", EmitDefaultValue = true)]
public bool? Nullable { get; set; }

Property Value

Type	Description
bool?

View Source

Pattern

Gets or Sets Pattern

Declaration

[DataMember(Name = "pattern", EmitDefaultValue = true)]
public string Pattern { get; set; }

Property Value

Type	Description
string

View Source

Properties

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.

Declaration

[DataMember(Name = "properties", EmitDefaultValue = true)]
public Dictionary<string, StructuredOutputSchema> Properties { get; set; }

Property Value

Type	Description
Dictionary<string, StructuredOutputSchema>	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.

View Source

PropertyOrdering

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

Declaration

[DataMember(Name = "propertyOrdering", EmitDefaultValue = true)]
public List<string> PropertyOrdering { get; set; }

Property Value

Type	Description
List<string>	Pass an array of property names to specify the order of properties in the generated JSON object if required.

View Source

Required

Gets or Sets Required

Declaration

[DataMember(Name = "required", EmitDefaultValue = true)]
public List<string> Required { get; set; }

Property Value

Type	Description
List<string>

View Source

Title

Gets or Sets Title

Declaration

[DataMember(Name = "title", EmitDefaultValue = true)]
public string Title { get; set; }

Property Value

Type	Description
string

View Source

Type

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

Declaration

[DataMember(Name = "type", EmitDefaultValue = true)]
public StructuredOutputSchema.TypeEnum? Type { get; set; }

Property Value

Type	Description
StructuredOutputSchema.TypeEnum?	Primitive JSON schema types with a fallback CUSTOM for unknown values.

Methods

View Source

ToJson()

Returns the JSON string presentation of the object

Declaration

public virtual string ToJson()

Returns

Type	Description
string	JSON string presentation of the object

View Source

ToString()

Returns the string presentation of the object

Declaration

public override string ToString()

Returns

Type	Description
string	String presentation of the object

Overrides

object.ToString()

Implements

IValidatableObject