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

use crate::{
    config::Config,
    error::OpenAIError,
    types::evals::{CreateEvalRunRequest, DeleteEvalRunResponse, EvalRun, EvalRunList},
    Client, EvalRunOutputItems, RequestOptions,
};

pub struct EvalRuns<'c, C: Config> {
    client: &'c Client<C>,
    pub eval_id: String,
    pub(crate) request_options: RequestOptions,
}

impl<'c, C: Config> EvalRuns<'c, C> {
    pub fn new(client: &'c Client<C>, eval_id: &str) -> Self {
        Self {
            client,
            eval_id: eval_id.into(),
            request_options: RequestOptions::new(),
        }
    }

    /// [EvalRunOutputItems] API group
    pub fn output_items(&self, run_id: &str) -> EvalRunOutputItems<'_, C> {
        EvalRunOutputItems::new(self.client, &self.eval_id, run_id)
    }

    /// Get a list of runs for an evaluation.
    #[crate::byot(R = serde::de::DeserializeOwned)]
    pub async fn list(&self) -> Result<EvalRunList, OpenAIError> {
        self.client
            .get(
                &format!("/evals/{}/runs", self.eval_id),
                &self.request_options,
            )
            .await
    }

    /// Kicks off a new run for a given evaluation.
    #[crate::byot(T0 = serde::Serialize, R = serde::de::DeserializeOwned)]
    pub async fn create(&self, request: CreateEvalRunRequest) -> Result<EvalRun, OpenAIError> {
        self.client
            .post(
                &format!("/evals/{}/runs", self.eval_id),
                request,
                &self.request_options,
            )
            .await
    }

    /// Get an evaluation run by ID.
    #[crate::byot(T0 = std::fmt::Display, R = serde::de::DeserializeOwned)]
    pub async fn retrieve(&self, run_id: &str) -> Result<EvalRun, OpenAIError> {
        self.client
            .get(
                &format!("/evals/{}/runs/{}", self.eval_id, run_id),
                &self.request_options,
            )
            .await
    }

    /// Cancel an ongoing evaluation run.
    #[crate::byot(T0 = std::fmt::Display, R = serde::de::DeserializeOwned)]
    pub async fn cancel(&self, run_id: &str) -> Result<EvalRun, OpenAIError> {
        self.client
            .post(
                &format!("/evals/{}/runs/{}", self.eval_id, run_id),
                serde_json::json!({}),
                &self.request_options,
            )
            .await
    }

    /// Delete an eval run.
    #[crate::byot(T0 = std::fmt::Display, R = serde::de::DeserializeOwned)]
    pub async fn delete(&self, run_id: &str) -> Result<DeleteEvalRunResponse, OpenAIError> {
        self.client
            .delete(
                &format!("/evals/{}/runs/{}", self.eval_id, run_id),
                &self.request_options,
            )
            .await
    }
}