openai-client-base 0.12.0

Auto-generated Rust client for the OpenAI API
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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167

/*
 * 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};

#[derive(Clone, Debug, PartialEq, Serialize, Deserialize, bon::Builder)]
pub struct Batch {
    #[serde(rename = "id")]
    pub id: String,
    /// The object type, which is always `batch`.
    #[serde(rename = "object")]
    pub object: Object,
    /// The OpenAI API endpoint used by the batch.
    #[serde(rename = "endpoint")]
    pub endpoint: String,
    /// Model ID used to process the batch, like `gpt-5-2025-08-07`. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [model guide](/docs/models) to browse and compare available models.
    #[serde(rename = "model", skip_serializing_if = "Option::is_none")]
    pub model: Option<String>,
    #[serde(rename = "errors", skip_serializing_if = "Option::is_none")]
    pub errors: Option<Box<models::BatchErrors>>,
    /// The ID of the input file for the batch.
    #[serde(rename = "input_file_id")]
    pub input_file_id: String,
    /// The time frame within which the batch should be processed.
    #[serde(rename = "completion_window")]
    pub completion_window: String,
    /// The current status of the batch.
    #[serde(rename = "status")]
    pub status: Status,
    /// The ID of the file containing the outputs of successfully executed requests.
    #[serde(rename = "output_file_id", skip_serializing_if = "Option::is_none")]
    pub output_file_id: Option<String>,
    /// The ID of the file containing the outputs of requests with errors.
    #[serde(rename = "error_file_id", skip_serializing_if = "Option::is_none")]
    pub error_file_id: Option<String>,
    /// The Unix timestamp (in seconds) for when the batch was created.
    #[serde(rename = "created_at")]
    pub created_at: i32,
    /// The Unix timestamp (in seconds) for when the batch started processing.
    #[serde(rename = "in_progress_at", skip_serializing_if = "Option::is_none")]
    pub in_progress_at: Option<i32>,
    /// The Unix timestamp (in seconds) for when the batch will expire.
    #[serde(rename = "expires_at", skip_serializing_if = "Option::is_none")]
    pub expires_at: Option<i32>,
    /// The Unix timestamp (in seconds) for when the batch started finalizing.
    #[serde(rename = "finalizing_at", skip_serializing_if = "Option::is_none")]
    pub finalizing_at: Option<i32>,
    /// The Unix timestamp (in seconds) for when the batch was completed.
    #[serde(rename = "completed_at", skip_serializing_if = "Option::is_none")]
    pub completed_at: Option<i32>,
    /// The Unix timestamp (in seconds) for when the batch failed.
    #[serde(rename = "failed_at", skip_serializing_if = "Option::is_none")]
    pub failed_at: Option<i32>,
    /// The Unix timestamp (in seconds) for when the batch expired.
    #[serde(rename = "expired_at", skip_serializing_if = "Option::is_none")]
    pub expired_at: Option<i32>,
    /// The Unix timestamp (in seconds) for when the batch started cancelling.
    #[serde(rename = "cancelling_at", skip_serializing_if = "Option::is_none")]
    pub cancelling_at: Option<i32>,
    /// The Unix timestamp (in seconds) for when the batch was cancelled.
    #[serde(rename = "cancelled_at", skip_serializing_if = "Option::is_none")]
    pub cancelled_at: Option<i32>,
    #[serde(rename = "request_counts", skip_serializing_if = "Option::is_none")]
    pub request_counts: Option<Box<models::BatchRequestCounts>>,
    #[serde(rename = "usage", skip_serializing_if = "Option::is_none")]
    pub usage: Option<Box<models::BatchUsage>>,
    /// Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.  Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.
    #[serde(
        rename = "metadata",
        default,
        with = "::serde_with::rust::double_option",
        skip_serializing_if = "Option::is_none"
    )]
    pub metadata: Option<Option<std::collections::HashMap<String, String>>>,
}

impl Batch {
    pub fn new(
        id: String,
        object: Object,
        endpoint: String,
        input_file_id: String,
        completion_window: String,
        status: Status,
        created_at: i32,
    ) -> Batch {
        Batch {
            id,
            object,
            endpoint,
            model: None,
            errors: None,
            input_file_id,
            completion_window,
            status,
            output_file_id: None,
            error_file_id: None,
            created_at,
            in_progress_at: None,
            expires_at: None,
            finalizing_at: None,
            completed_at: None,
            failed_at: None,
            expired_at: None,
            cancelling_at: None,
            cancelled_at: None,
            request_counts: None,
            usage: None,
            metadata: None,
        }
    }
}
/// The object type, which is always `batch`.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum Object {
    #[serde(rename = "batch")]
    Batch,
}

impl Default for Object {
    fn default() -> Object {
        Self::Batch
    }
}
/// The current status of the batch.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum Status {
    #[serde(rename = "validating")]
    Validating,
    #[serde(rename = "failed")]
    Failed,
    #[serde(rename = "in_progress")]
    InProgress,
    #[serde(rename = "finalizing")]
    Finalizing,
    #[serde(rename = "completed")]
    Completed,
    #[serde(rename = "expired")]
    Expired,
    #[serde(rename = "cancelling")]
    Cancelling,
    #[serde(rename = "cancelled")]
    Cancelled,
}

impl Default for Status {
    fn default() -> Status {
        Self::Validating
    }
}

impl std::fmt::Display for Batch {
    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),
        }
    }
}