floopy-sdk 0.1.0

Official Floopy AI Gateway SDK for Rust. Drop-in wrapper around the async-openai crate with cache, audit, experiments, and security on top.
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

use serde::{Deserialize, Serialize};

/// An A/B routing experiment.
#[derive(Debug, Clone, Deserialize)]
pub struct Experiment {
    /// Experiment id.
    pub id: String,
    /// Display name.
    pub name: String,
    /// Optional description.
    pub description: Option<String>,
    /// Lifecycle state (`active`, `rolled_back`, `completed`).
    pub status: String,
    /// Routing rule id for variant A.
    pub variant_a_routing_rule_id: String,
    /// Routing rule id for variant B.
    pub variant_b_routing_rule_id: String,
    /// Percentage of traffic on variant B.
    pub split_percentage: i32,
    /// RFC3339 creation timestamp.
    pub created_at: String,
    /// RFC3339 rollback timestamp, if rolled back.
    pub rolled_back_at: Option<String>,
}

/// One page of [`crate::resources::Experiments::list`].
#[derive(Debug, Clone, Deserialize)]
pub struct ExperimentListPage {
    /// Experiments in this page.
    pub items: Vec<Experiment>,
    /// Cursor for the next page, if any.
    pub next_cursor: Option<String>,
    /// Whether more pages follow.
    pub has_more: bool,
}

/// Aggregated metrics for one experiment variant.
#[derive(Debug, Clone, Deserialize)]
pub struct VariantResults {
    /// Routing rule id for this variant.
    pub routing_rule_id: String,
    /// Number of samples observed.
    pub sample_size: i64,
    /// Fraction of successful requests.
    pub success_rate: f64,
    /// Mean latency in milliseconds.
    pub average_latency_ms: f64,
    /// Mean cost in micro-USD.
    pub average_cost_micro_usd: f64,
}

/// Computed outcome of an experiment.
#[derive(Debug, Clone, Deserialize)]
pub struct ExperimentResults {
    /// Experiment id.
    pub experiment_id: String,
    /// Variant A metrics.
    pub variant_a: VariantResults,
    /// Variant B metrics.
    pub variant_b: VariantResults,
    /// `"A"`, `"B"`, `"tie"`, or `None` when undecided.
    pub winner: Option<String>,
    /// RFC3339 timestamp the results were computed.
    pub computed_at: String,
}

/// Filters for [`crate::resources::Experiments::list`].
#[derive(Debug, Clone, Default)]
pub struct ExperimentListParams {
    /// Restrict to one lifecycle state.
    pub status: Option<String>,
    /// Inclusive lower bound (RFC3339).
    pub from: Option<String>,
    /// Inclusive upper bound (RFC3339).
    pub to: Option<String>,
    /// Page size.
    pub limit: Option<u32>,
    /// Opaque pagination cursor.
    pub cursor: Option<String>,
}

impl ExperimentListParams {
    pub(crate) fn query(&self) -> Vec<(String, String)> {
        let mut q = Vec::new();
        if let Some(v) = &self.status {
            q.push(("status".to_owned(), v.clone()));
        }
        if let Some(v) = &self.from {
            q.push(("from".to_owned(), v.clone()));
        }
        if let Some(v) = &self.to {
            q.push(("to".to_owned(), v.clone()));
        }
        if let Some(v) = self.limit {
            q.push(("limit".to_owned(), v.to_string()));
        }
        if let Some(v) = &self.cursor {
            q.push(("cursor".to_owned(), v.clone()));
        }
        q
    }
}

/// Arguments for [`crate::resources::Experiments::create`].
#[derive(Debug, Clone, Serialize)]
pub struct ExperimentCreateParams {
    /// Display name.
    pub name: String,
    /// Routing rule id for variant A.
    pub variant_a_routing_rule_id: String,
    /// Routing rule id for variant B.
    pub variant_b_routing_rule_id: String,
    /// Optional description.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    /// Optional percentage of traffic on variant B.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub split_percentage: Option<i32>,
}