Struct ResponseFormatJsonSchema 

pub struct ResponseFormatJsonSchema {
    pub description: Option<String>,
    pub name: String,
    pub schema: Option<Value>,
    pub strict: Option<bool>,
}

Available on crate feature chat-completion-types only.

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<Value>

The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas here.

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.

Trait Implementations

impl Clone for ResponseFormatJsonSchema

Available on (crate features chat-completion-types or response-types or assistant-types) and (crate features response-types or video-types or vectorstore-types or chat-completion-types or assistant-types or batch-types or audio-types or realtime-types or image-types) only.

fn clone(&self) -> ResponseFormatJsonSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResponseFormatJsonSchema

Available on (crate features chat-completion-types or response-types or assistant-types) and (crate features response-types or video-types or vectorstore-types or chat-completion-types or assistant-types or batch-types or audio-types or realtime-types or image-types) only.

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ResponseFormatJsonSchema

Available on (crate features chat-completion-types or response-types or assistant-types) and (crate features response-types or video-types or vectorstore-types or chat-completion-types or assistant-types or batch-types or audio-types or realtime-types or image-types) only.

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ResponseFormatJsonSchema> for ResponseTextParam

Available on crate feature response-types only.

fn from(schema: ResponseFormatJsonSchema) -> Self

Converts to this type from the input type.

impl PartialEq for ResponseFormatJsonSchema

Available on (crate features chat-completion-types or response-types or assistant-types) and (crate features response-types or video-types or vectorstore-types or chat-completion-types or assistant-types or batch-types or audio-types or realtime-types or image-types) only.

fn eq(&self, other: &ResponseFormatJsonSchema) -> 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 ResponseFormatJsonSchema

Available on (crate features chat-completion-types or response-types or assistant-types) and (crate features response-types or video-types or vectorstore-types or chat-completion-types or assistant-types or batch-types or audio-types or realtime-types or image-types) only.

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 ResponseFormatJsonSchema

Available on (crate features chat-completion-types or response-types or assistant-types) and (crate features response-types or video-types or vectorstore-types or chat-completion-types or assistant-types or batch-types or audio-types or realtime-types or image-types) only.