1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
/*
* OpenAI API
*
* The OpenAI REST API. Please see https://platform.openai.com/docs/api-reference for more details.
*
* The version of the OpenAPI document: 2.3.0
*
* Generated by: https://openapi-generator.tech
*/
use crate::models;
use serde::{Deserialize, Serialize};
/// ResponseFormatJsonSchema : JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](/docs/guides/structured-outputs).
#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize, bon::Builder)]
pub struct ResponseFormatJsonSchema {
/// The type of response format being defined. Always `json_schema`.
#[serde(rename = "type")]
pub r#type: Type,
#[serde(rename = "json_schema")]
pub json_schema: Box<models::JsonSchema>,
}
impl ResponseFormatJsonSchema {
/// JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](/docs/guides/structured-outputs).
pub fn new(r#type: Type, json_schema: models::JsonSchema) -> ResponseFormatJsonSchema {
ResponseFormatJsonSchema {
r#type,
json_schema: Box::new(json_schema),
}
}
}
/// The type of response format being defined. Always `json_schema`.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum Type {
#[serde(rename = "json_schema")]
JsonSchema,
}
impl Default for Type {
fn default() -> Type {
Self::JsonSchema
}
}
impl std::fmt::Display for ResponseFormatJsonSchema {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match serde_json::to_string(self) {
Ok(s) => write!(f, "{}", s),
Err(_) => Err(std::fmt::Error),
}
}
}