outfox_openai/spec/files/
api.rs

1use derive_builder::Builder;
2use serde::{Deserialize, Serialize};
3
4use crate::error::OpenAIError;
5
6/// Sort order for listing files.
7#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
8#[serde(rename_all = "lowercase")]
9pub enum ListFilesOrder {
10    /// Ascending order
11    Asc,
12    /// Descending order
13    Desc,
14}
15
16/// Query parameters for listing files.
17#[derive(Debug, Serialize, Default, Clone, Builder, PartialEq)]
18#[builder(name = "ListFilesQueryArgs")]
19#[builder(pattern = "mutable")]
20#[builder(setter(into, strip_option), default)]
21#[builder(derive(Debug))]
22#[builder(build_fn(error = "OpenAIError"))]
23pub struct ListFilesQuery {
24    /// Only return files with the given purpose.
25    #[serde(skip_serializing_if = "Option::is_none")]
26    pub purpose: Option<String>,
27    /// A limit on the number of objects to be returned. Limit can range between 1 and 10,000, and
28    /// the default is 10,000.
29    #[serde(skip_serializing_if = "Option::is_none")]
30    pub limit: Option<u32>,
31    /// Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and
32    /// `desc` for descending order.
33    #[serde(skip_serializing_if = "Option::is_none")]
34    pub order: Option<ListFilesOrder>,
35    /// A cursor for use in pagination. `after` is an object ID that defines your place in the
36    /// list.
37    #[serde(skip_serializing_if = "Option::is_none")]
38    pub after: Option<String>,
39}
outfox_openai/spec/files/api.rs

outfox_openai/spec/files/
api.rs
