async-openai 0.34.0

Rust library for OpenAI
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

use crate::error::OpenAIError;
use derive_builder::Builder;
use serde::{Deserialize, Serialize};

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

/// Order by field for listing evals.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum ListEvalsOrderBy {
    /// Order by creation time
    CreatedAt,
    /// Order by last updated time
    UpdatedAt,
}

/// Query parameters for listing evals.
#[derive(Debug, Serialize, Default, Clone, Builder, PartialEq)]
#[builder(name = "ListEvalsQueryArgs")]
#[builder(pattern = "mutable")]
#[builder(setter(into, strip_option), default)]
#[builder(derive(Debug))]
#[builder(build_fn(error = "OpenAIError"))]
pub struct ListEvalsQuery {
    /// Identifier for the last eval from the previous pagination request.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub after: Option<String>,
    /// Number of evals to retrieve.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub limit: Option<u32>,
    /// Sort order for evals by timestamp. Use `asc` for ascending order or `desc` for descending order.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub order: Option<ListEvalsOrder>,
    /// Evals can be ordered by creation time or last updated time. Use `created_at` for creation time or `updated_at` for last updated time.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub order_by: Option<ListEvalsOrderBy>,
}

/// Sort order for getting eval runs.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[serde(rename_all = "lowercase")]
pub enum GetEvalRunsOrder {
    /// Ascending order
    Asc,
    /// Descending order
    Desc,
}

/// Status filter for eval runs.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum GetEvalRunsStatus {
    /// Queued status
    Queued,
    /// In progress status
    InProgress,
    /// Completed status
    Completed,
    /// Canceled status
    Canceled,
    /// Failed status
    Failed,
}

/// Query parameters for getting eval runs.
#[derive(Debug, Serialize, Default, Clone, Builder, PartialEq)]
#[builder(name = "GetEvalRunsQueryArgs")]
#[builder(pattern = "mutable")]
#[builder(setter(into, strip_option), default)]
#[builder(derive(Debug))]
#[builder(build_fn(error = "OpenAIError"))]
pub struct GetEvalRunsQuery {
    /// Identifier for the last run from the previous pagination request.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub after: Option<String>,
    /// Number of runs to retrieve.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub limit: Option<u32>,
    /// Sort order for runs by timestamp. Use `asc` for ascending order or `desc` for descending order. Defaults to `asc`.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub order: Option<GetEvalRunsOrder>,
    /// Filter runs by status. One of `queued` | `in_progress` | `failed` | `completed` | `canceled`.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub status: Option<GetEvalRunsStatus>,
}

/// Sort order for getting eval run output items.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[serde(rename_all = "lowercase")]
pub enum GetEvalRunOutputItemsOrder {
    /// Ascending order
    Asc,
    /// Descending order
    Desc,
}

/// Status filter for eval run output items.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[serde(rename_all = "lowercase")]
pub enum GetEvalRunOutputItemsStatus {
    /// Failed status
    Fail,
    /// Pass status
    Pass,
}

/// Query parameters for getting eval run output items.
#[derive(Debug, Serialize, Default, Clone, Builder, PartialEq)]
#[builder(name = "GetEvalRunOutputItemsQueryArgs")]
#[builder(pattern = "mutable")]
#[builder(setter(into, strip_option), default)]
#[builder(derive(Debug))]
#[builder(build_fn(error = "OpenAIError"))]
pub struct GetEvalRunOutputItemsQuery {
    /// Identifier for the last output item from the previous pagination request.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub after: Option<String>,
    /// Number of output items to retrieve.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub limit: Option<u32>,
    /// Filter output items by status. Use `failed` to filter by failed output items or `pass` to filter by passed output items.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub status: Option<GetEvalRunOutputItemsStatus>,
    /// Sort order for output items by timestamp. Use `asc` for ascending order or `desc` for descending order. Defaults to `asc`.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub order: Option<GetEvalRunOutputItemsOrder>,
}