Struct ResponseTextConfigFormat 

pub struct ResponseTextConfigFormat {
    pub name: Option<String>,
    pub schema: Option<FunctionParameters>,
    pub strict: bool,
    pub type_: ResponseTextConfigFormatType,
}

An object specifying the format that the model must output.

JSON schema

{
 "description": "An object specifying the format that the model must output.",
 "type": "object",
 "required": [
   "type"
 ],
 "properties": {
   "name": {
     "description": "The name of the response format (used with `json_schema`).",
     "type": "string"
   },
   "schema": {
     "$ref": "#/definitions/FunctionParameters"
   },
   "strict": {
     "description": "Whether to enable strict schema adherence.",
     "default": false,
     "type": "boolean"
   },
   "type": {
     "description": "The type of response format being defined.",
     "type": "string",
     "enum": [
       "text",
       "json_schema",
       "json_object"
     ]
   }
 }
}

Fields

name: Option<String>

The name of the response format (used with json_schema).

schema: Option<FunctionParameters>

strict: bool

Whether to enable strict schema adherence.

type_: ResponseTextConfigFormatType

The type of response format being defined.

Trait Implementations

impl Clone for ResponseTextConfigFormat

fn clone(&self) -> ResponseTextConfigFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResponseTextConfigFormat

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ResponseTextConfigFormat

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ResponseTextConfigFormat

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.