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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
/*
* OpenAI API
*
* The OpenAI REST API. Please see pub https://platform.openai.com/docs/api-reference for more details.
*
* OpenAPI spec pub version: 2.3.0
*
* Generated pub by: https://github.com/swagger-api/swagger-codegen.git
*/
/// pub ResponseFormatJsonSchema : JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](/docs/guides/structured-outputs).
#[allow(unused_imports)]
use serde_json::Value;
/// # on openapi.yaml
///
/// ```yaml
/// ResponseFormatJsonSchema:
/// type: object
/// title: JSON schema
/// description: |
/// JSON Schema response format. Used to generate structured JSON responses.
/// Learn more about [Structured Outputs](/docs/guides/structured-outputs).
/// properties:
/// type:
/// type: string
/// description: The type of response format being defined. Always `json_schema`.
/// enum:
/// - json_schema
/// x-stainless-const: true
/// json_schema:
/// type: object
/// title: JSON schema
/// description: |
/// Structured Outputs configuration options, including a JSON Schema.
/// properties:
/// description:
/// type: string
/// description: >
/// A description of what the response format is for, used by the
/// model to
///
/// determine how to respond in the format.
/// name:
/// type: string
/// 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.
/// schema:
/// $ref: "#/components/schemas/ResponseFormatJsonSchemaSchema"
/// strict:
/// type: boolean
/// nullable: true
/// default: false
/// 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`. To learn more, read the [Structured Outputs
///
/// guide](/docs/guides/structured-outputs).
/// required:
/// - name
/// required:
/// - type
/// - json_schema
/// ```
#[derive(Debug, Serialize, Deserialize)]
pub struct ResponseFormatJsonSchema {
#[serde(rename = "json_schema")]
pub json_schema: crate::models::JsonSchema,
}