Enum ModelResponseFormat 

pub enum ModelResponseFormat {
    Text,
    JsonObject,
    JsonSchema {
        schema: Value,
        name: Option<String>,
        description: Option<String>,
        strict: Option<bool>,
    },
}

Response format parameter for structured outputs (Responses API).

Variants

Text

Specify text response format, always "text".

JsonObject

Specify json_object response format.

JsonSchema

Specify json_schema response format with a given schema.

Fields

schema: Value

A json schema representing the desired response schema.

name: Option<String>

Only included for compatibility.

description: Option<String>

Only included for compatibility.

strict: Option<bool>

Only included for compatibility.

Trait Implementations

impl Clone for ModelResponseFormat

fn clone(&self) -> ModelResponseFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModelResponseFormat

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

Formats the value using the given formatter.

impl Default for ModelResponseFormat

fn default() -> ModelResponseFormat

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ModelResponseFormat

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ModelResponseFormat

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

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 ModelResponseFormat