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

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

use crate::error::OpenAIError;

/// Query parameters for organization usage endpoints.
#[derive(Debug, Clone, Serialize, Default, Builder)]
#[builder(name = "UsageQueryParamsArgs")]
#[builder(pattern = "mutable")]
#[builder(setter(into, strip_option), default)]
#[builder(derive(Debug))]
#[builder(build_fn(error = "OpenAIError"))]
pub struct UsageQueryParams {
    /// Start time (Unix seconds) of the query time range, inclusive.
    pub start_time: u64,
    /// End time (Unix seconds) of the query time range, exclusive.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub end_time: Option<u64>,
    /// Width of each time bucket in response. Currently `1m`, `1h` and `1d` are supported, default
    /// to `1d`.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub bucket_width: Option<UsageBucketWidth>,
    /// Return only usage for these projects.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub project_ids: Option<Vec<String>>,
    /// Return only usage for these users.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub user_ids: Option<Vec<String>>,
    /// Return only usage for these API keys.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub api_key_ids: Option<Vec<String>>,
    /// Return only usage for these models.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub models: Option<Vec<String>>,
    /// If `true`, return batch jobs only. If `false`, return non-batch jobs only. By default,
    /// return both.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub batch: Option<bool>,
    /// Group the usage data by the specified fields.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub group_by: Option<Vec<UsageGroupBy>>,
    /// Specifies the number of buckets to return.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub limit: Option<u32>,
    /// A cursor for use in pagination. Corresponding to the `next_page` field from the previous
    /// response.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub page: Option<String>,
}

/// Width of each time bucket in response.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum UsageBucketWidth {
    #[serde(rename = "1m")]
    OneMinute,
    #[serde(rename = "1h")]
    OneHour,
    #[serde(rename = "1d")]
    OneDay,
}

/// Fields to group usage data by.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum UsageGroupBy {
    ProjectId,
    UserId,
    ApiKeyId,
    Model,
    Batch,
    ServiceTier,
}