openai-client-base 0.16.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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217

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

/// RunObject : Represents an execution run on a [thread](https://developers.openai.com/api/docs/assistants/migration).
#[derive(Clone, Debug, PartialEq, Serialize, Deserialize, bon::Builder)]
pub struct RunObject {
    /// The identifier, which can be referenced in API endpoints.
    #[serde(rename = "id")]
    pub id: String,
    /// The object type, which is always `thread.run`.
    #[serde(rename = "object")]
    pub object: Object,
    /// The Unix timestamp (in seconds) for when the run was created.
    #[serde(rename = "created_at")]
    pub created_at: i32,
    /// The ID of the [thread](https://developers.openai.com/api/docs/assistants/migration) that was executed on as a part of this run.
    #[serde(rename = "thread_id")]
    pub thread_id: String,
    /// The ID of the [assistant](https://developers.openai.com/api/docs/assistants/migration) used for execution of this run.
    #[serde(rename = "assistant_id")]
    pub assistant_id: String,
    /// The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`.
    #[serde(rename = "status")]
    pub status: Status,
    #[serde(rename = "required_action")]
    pub required_action: Option<Box<models::RunObjectRequiredAction>>,
    #[serde(rename = "last_error")]
    pub last_error: Option<Box<models::RunObjectLastError>>,
    /// The Unix timestamp (in seconds) for when the run will expire.
    #[serde(rename = "expires_at", deserialize_with = "Option::deserialize")]
    pub expires_at: Option<i32>,
    /// The Unix timestamp (in seconds) for when the run was started.
    #[serde(rename = "started_at", deserialize_with = "Option::deserialize")]
    pub started_at: Option<i32>,
    /// The Unix timestamp (in seconds) for when the run was cancelled.
    #[serde(rename = "cancelled_at", deserialize_with = "Option::deserialize")]
    pub cancelled_at: Option<i32>,
    /// The Unix timestamp (in seconds) for when the run failed.
    #[serde(rename = "failed_at", deserialize_with = "Option::deserialize")]
    pub failed_at: Option<i32>,
    /// The Unix timestamp (in seconds) for when the run was completed.
    #[serde(rename = "completed_at", deserialize_with = "Option::deserialize")]
    pub completed_at: Option<i32>,
    #[serde(rename = "incomplete_details")]
    pub incomplete_details: Option<Box<models::RunObjectIncompleteDetails>>,
    /// The model that the [assistant](https://developers.openai.com/api/docs/assistants/migration) used for this run.
    #[serde(rename = "model")]
    pub model: String,
    /// The instructions that the [assistant](https://developers.openai.com/api/docs/assistants/migration) used for this run.
    #[serde(rename = "instructions")]
    pub instructions: String,
    /// The list of tools that the [assistant](https://developers.openai.com/api/docs/assistants/migration) used for this run.
    #[serde(rename = "tools")]
    pub tools: Vec<models::AssistantObjectToolsInner>,
    /// 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", deserialize_with = "Option::deserialize")]
    pub metadata: Option<std::collections::HashMap<String, String>>,
    #[serde(rename = "usage", deserialize_with = "Option::deserialize")]
    pub usage: Option<Box<models::RunCompletionUsage>>,
    /// The sampling temperature used for this run. If not set, defaults to 1.
    #[serde(
        rename = "temperature",
        default,
        with = "::serde_with::rust::double_option",
        skip_serializing_if = "Option::is_none"
    )]
    pub temperature: Option<Option<f64>>,
    /// The nucleus sampling value used for this run. If not set, defaults to 1.
    #[serde(
        rename = "top_p",
        default,
        with = "::serde_with::rust::double_option",
        skip_serializing_if = "Option::is_none"
    )]
    pub top_p: Option<Option<f64>>,
    /// The maximum number of prompt tokens specified to have been used over the course of the run.
    #[serde(rename = "max_prompt_tokens", deserialize_with = "Option::deserialize")]
    pub max_prompt_tokens: Option<i32>,
    /// The maximum number of completion tokens specified to have been used over the course of the run.
    #[serde(
        rename = "max_completion_tokens",
        deserialize_with = "Option::deserialize"
    )]
    pub max_completion_tokens: Option<i32>,
    #[serde(
        rename = "truncation_strategy",
        deserialize_with = "Option::deserialize"
    )]
    pub truncation_strategy: Option<Box<models::TruncationObject>>,
    #[serde(rename = "tool_choice", deserialize_with = "Option::deserialize")]
    pub tool_choice: Option<Box<models::AssistantsApiToolChoiceOption>>,
    /// Whether to enable [parallel function calling](https://developers.openai.com/api/docs/guides/function-calling#parallel-function-calling) during tool use.
    #[serde(rename = "parallel_tool_calls")]
    pub parallel_tool_calls: bool,
    #[serde(rename = "response_format", deserialize_with = "Option::deserialize")]
    pub response_format: Option<Box<models::AssistantsApiResponseFormatOption>>,
}

impl RunObject {
    /// Represents an execution run on a [thread](https://developers.openai.com/api/docs/assistants/migration).
    pub fn new(
        id: String,
        object: Object,
        created_at: i32,
        thread_id: String,
        assistant_id: String,
        status: Status,
        required_action: Option<models::RunObjectRequiredAction>,
        last_error: Option<models::RunObjectLastError>,
        expires_at: Option<i32>,
        started_at: Option<i32>,
        cancelled_at: Option<i32>,
        failed_at: Option<i32>,
        completed_at: Option<i32>,
        incomplete_details: Option<models::RunObjectIncompleteDetails>,
        model: String,
        instructions: String,
        tools: Vec<models::AssistantObjectToolsInner>,
        metadata: Option<std::collections::HashMap<String, String>>,
        usage: Option<models::RunCompletionUsage>,
        max_prompt_tokens: Option<i32>,
        max_completion_tokens: Option<i32>,
        truncation_strategy: Option<models::TruncationObject>,
        tool_choice: Option<models::AssistantsApiToolChoiceOption>,
        parallel_tool_calls: bool,
        response_format: Option<models::AssistantsApiResponseFormatOption>,
    ) -> RunObject {
        RunObject {
            id,
            object,
            created_at,
            thread_id,
            assistant_id,
            status,
            required_action: required_action.map(Box::new),
            last_error: last_error.map(Box::new),
            expires_at,
            started_at,
            cancelled_at,
            failed_at,
            completed_at,
            incomplete_details: incomplete_details.map(Box::new),
            model,
            instructions,
            tools,
            metadata,
            usage: usage.map(Box::new),
            temperature: None,
            top_p: None,
            max_prompt_tokens,
            max_completion_tokens,
            truncation_strategy: truncation_strategy.map(Box::new),
            tool_choice: tool_choice.map(Box::new),
            parallel_tool_calls,
            response_format: response_format.map(Box::new),
        }
    }
}
/// The object type, which is always `thread.run`.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum Object {
    #[serde(rename = "thread.run")]
    ThreadRun,
}

impl Default for Object {
    fn default() -> Object {
        Self::ThreadRun
    }
}
/// The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum Status {
    #[serde(rename = "queued")]
    Queued,
    #[serde(rename = "in_progress")]
    InProgress,
    #[serde(rename = "requires_action")]
    RequiresAction,
    #[serde(rename = "cancelling")]
    Cancelling,
    #[serde(rename = "cancelled")]
    Cancelled,
    #[serde(rename = "failed")]
    Failed,
    #[serde(rename = "completed")]
    Completed,
    #[serde(rename = "incomplete")]
    Incomplete,
    #[serde(rename = "expired")]
    Expired,
}

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

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