Struct ResponseFormat 

pub struct ResponseFormat {
    pub type: Option<ResponseFormats>,
    pub json_schema: Option<Option<Box<JsonSchema>>>,
}

ResponseFormat : Specify the format that the model must output. By default it will use { \"type\": \"text\" }. Setting to { \"type\": \"json_object\" } enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. Setting to { \"type\": \"json_schema\" } enables JSON schema mode, which guarantees the message the model generates is in JSON and follows the schema you provide.

Fields

type: Option<ResponseFormats>

json_schema: Option<Option<Box<JsonSchema>>>

Implementations

impl ResponseFormat

pub fn new() -> ResponseFormat

Specify the format that the model must output. By default it will use { \"type\": \"text\" }. Setting to { \"type\": \"json_object\" } enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. Setting to { \"type\": \"json_schema\" } enables JSON schema mode, which guarantees the message the model generates is in JSON and follows the schema you provide.

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