outfox-openai 0.7.0

Openai for outfox
Documentation 
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

use derive_builder::Builder;
use serde::{Deserialize, Serialize};

use crate::error::OpenAIError;

/// Sort order for listing vector stores.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[serde(rename_all = "lowercase")]
pub enum ListVectorStoresOrder {
    /// Ascending order
    Asc,
    /// Descending order
    Desc,
}

/// Query parameters for listing vector stores.
#[derive(Debug, Serialize, Default, Clone, Builder, PartialEq)]
#[builder(name = "ListVectorStoresQueryArgs")]
#[builder(pattern = "mutable")]
#[builder(setter(into, strip_option), default)]
#[builder(derive(Debug))]
#[builder(build_fn(error = "OpenAIError"))]
pub struct ListVectorStoresQuery {
    /// A limit on the number of objects to be returned. Limit can range between 1 and 100, and the
    /// default is 20.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub limit: Option<u32>,
    /// Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and
    /// `desc` for descending order.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub order: Option<ListVectorStoresOrder>,
    /// A cursor for use in pagination. `after` is an object ID that defines your place in the
    /// list.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub after: Option<String>,
    /// A cursor for use in pagination. `before` is an object ID that defines your place in the
    /// list.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub before: Option<String>,
}

/// Sort order for listing files in vector store batch.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[serde(rename_all = "lowercase")]
pub enum ListFilesInVectorStoreBatchOrder {
    /// Ascending order
    Asc,
    /// Descending order
    Desc,
}

/// Filter by file status for files in vector store batch.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum ListFilesInVectorStoreBatchFilter {
    /// In progress status
    InProgress,
    /// Completed status
    Completed,
    /// Failed status
    Failed,
    /// Cancelled status
    Cancelled,
}

/// Query parameters for listing files in vector store batch.
#[derive(Debug, Serialize, Default, Clone, Builder, PartialEq)]
#[builder(name = "ListFilesInVectorStoreBatchQueryArgs")]
#[builder(pattern = "mutable")]
#[builder(setter(into, strip_option), default)]
#[builder(derive(Debug))]
#[builder(build_fn(error = "OpenAIError"))]
pub struct ListFilesInVectorStoreBatchQuery {
    /// A limit on the number of objects to be returned. Limit can range between 1 and 100, and the
    /// default is 20.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub limit: Option<u32>,
    /// Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and
    /// `desc` for descending order.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub order: Option<ListFilesInVectorStoreBatchOrder>,
    /// A cursor for use in pagination. `after` is an object ID that defines your place in the
    /// list.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub after: Option<String>,
    /// A cursor for use in pagination. `before` is an object ID that defines your place in the
    /// list.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub before: Option<String>,
    /// Filter by file status. One of `in_progress`, `completed`, `failed`, `cancelled`.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub filter: Option<ListFilesInVectorStoreBatchFilter>,
}

/// Sort order for listing vector store files.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[serde(rename_all = "lowercase")]
pub enum ListVectorStoreFilesOrder {
    /// Ascending order
    Asc,
    /// Descending order
    Desc,
}

/// Filter by file status for vector store files.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum ListVectorStoreFilesFilter {
    /// In progress status
    InProgress,
    /// Completed status
    Completed,
    /// Failed status
    Failed,
    /// Cancelled status
    Cancelled,
}

/// Query parameters for listing vector store files.
#[derive(Debug, Serialize, Default, Clone, Builder, PartialEq)]
#[builder(name = "ListVectorStoreFilesQueryArgs")]
#[builder(pattern = "mutable")]
#[builder(setter(into, strip_option), default)]
#[builder(derive(Debug))]
#[builder(build_fn(error = "OpenAIError"))]
pub struct ListVectorStoreFilesQuery {
    /// A limit on the number of objects to be returned. Limit can range between 1 and 100, and the
    /// default is 20.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub limit: Option<u32>,
    /// Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and
    /// `desc` for descending order.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub order: Option<ListVectorStoreFilesOrder>,
    /// A cursor for use in pagination. `after` is an object ID that defines your place in the
    /// list.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub after: Option<String>,
    /// A cursor for use in pagination. `before` is an object ID that defines your place in the
    /// list.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub before: Option<String>,
    /// Filter by file status. One of `in_progress`, `completed`, `failed`, `cancelled`.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub filter: Option<ListVectorStoreFilesFilter>,
}