Struct ResponseFormatJsonSchemaJsonSchema

pub struct ResponseFormatJsonSchemaJsonSchema {
    pub description: Option<String>,
    pub name: String,
    pub schema: Option<ResponseFormatJsonSchemaSchema>,
    pub strict: Option<bool>,
}

Structured Outputs configuration options, including a JSON Schema.

Fields

description: Option<String>

A description of what the response format is for, used by the model to determine how to respond in the format.

name: String

The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.

schema: Option<ResponseFormatJsonSchemaSchema>

strict: Option<bool>

Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when strict is true. To learn more, read the Structured Outputs guide.

Implementations

impl ResponseFormatJsonSchemaJsonSchema

pub fn builder() -> ResponseFormatJsonSchemaJsonSchemaBuilder<((), (), (), ())>

Create a builder for building ResponseFormatJsonSchemaJsonSchema. On the builder, call .description(...)(optional), .name(...), .schema(...)(optional), .strict(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of ResponseFormatJsonSchemaJsonSchema.

Trait Implementations

impl Clone for ResponseFormatJsonSchemaJsonSchema

fn clone(&self) -> ResponseFormatJsonSchemaJsonSchema

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ResponseFormatJsonSchemaJsonSchema

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ResponseFormatJsonSchemaJsonSchema

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ResponseFormatJsonSchemaJsonSchema

fn eq(&self, other: &ResponseFormatJsonSchemaJsonSchema) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ResponseFormatJsonSchemaJsonSchema

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ResponseFormatJsonSchemaJsonSchema