Enum ResponseFormat 

pub enum ResponseFormat {
    Text,
    JsonObject,
    JsonSchema {
        json_schema: Value,
    },
}

Response format parameter for structured outputs.

Variants

Text

Specify text response format, always "text".

JsonObject

Specify json_object response format, always json_object. Used for backward compatibility. Prefer to use "json_schema" instead.

JsonSchema

Specify json_schema response format with a given schema.

Fields

json_schema: Value

A json schema representing the desired response schema.

Trait Implementations

impl Clone for ResponseFormat

fn clone(&self) -> ResponseFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResponseFormat

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

Formats the value using the given formatter.

impl Default for ResponseFormat

fn default() -> ResponseFormat

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ResponseFormat

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ResponseFormat

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

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 ResponseFormat