Struct ResponseFormatJsonSchema 

pub struct ResponseFormatJsonSchema {
    pub json_schema: ResponseFormatJsonSchemaJsonSchema,
    pub type_: ResponseFormatJsonSchemaType,
}

JSON Schema response format. Used to generate structured JSON responses.

JSON schema

{
 "description": "JSON Schema response format. Used to generate structured JSON responses.\n",
 "type": "object",
 "required": [
   "json_schema",
   "type"
 ],
 "properties": {
   "json_schema": {
     "description": "Structured Outputs configuration options, including a JSON Schema.",
     "type": "object",
     "required": [
       "name"
     ],
     "properties": {
       "description": {
         "description": "A description of what the response format is for, used by the model to determine how to respond in the format.\n",
         "type": "string"
       },
       "name": {
         "description": "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.\n",
         "type": "string"
       },
       "schema": {
         "$ref": "#/definitions/ResponseFormatJsonSchemaSchema"
       },
       "strict": {
         "description": "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`.\n",
         "default": false,
         "type": "boolean"
       }
     }
   },
   "type": {
     "description": "The type of response format being defined. Always `json_schema`.",
     "type": "string",
     "enum": [
       "json_schema"
     ]
   }
 }
}

Fields

json_schema: ResponseFormatJsonSchemaJsonSchema

type_: ResponseFormatJsonSchemaType

The type of response format being defined. Always json_schema.

Trait Implementations

impl Clone for ResponseFormatJsonSchema

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

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

Formats the value using the given formatter.

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

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 CreateChatCompletionRequestResponseFormat

fn from(value: ResponseFormatJsonSchema) -> Self

Converts to this type from the input type.

impl Serialize for ResponseFormatJsonSchema

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

where __S: Serializer,

Serialize this value into the given Serde serializer.