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

use crate::{
    config::Config,
    error::OpenAIError,
    types::evals::{CreateEvalRequest, DeleteEvalResponse, Eval, EvalList, UpdateEvalRequest},
    Client, EvalRuns, RequestOptions,
};

/// Create, manage, and run evals in the OpenAI platform. Related guide:
/// [Evals](https://platform.openai.com/docs/guides/evals)
pub struct Evals<'c, C: Config> {
    client: &'c Client<C>,
    pub(crate) request_options: RequestOptions,
}

impl<'c, C: Config> Evals<'c, C> {
    pub fn new(client: &'c Client<C>) -> Self {
        Self {
            client,
            request_options: RequestOptions::new(),
        }
    }

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

    /// List evaluations for a project.
    #[crate::byot(R = serde::de::DeserializeOwned)]
    pub async fn list(&self) -> Result<EvalList, OpenAIError> {
        self.client.get("/evals", &self.request_options).await
    }

    /// Create the structure of an evaluation that can be used to test a model's performance.
    /// An evaluation is a set of testing criteria and the config for a data source, which dictates
    /// the schema of the data used in the evaluation. After creating an evaluation, you can run it
    /// on different models and model parameters. We support several types of graders and
    /// datasources. For more information, see the [Evals guide](https://platform.openai.com/docs/guides/evals).
    #[crate::byot(T0 = serde::Serialize, R = serde::de::DeserializeOwned)]
    pub async fn create(&self, request: CreateEvalRequest) -> Result<Eval, OpenAIError> {
        self.client
            .post("/evals", request, &self.request_options)
            .await
    }

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

    /// Update certain properties of an evaluation.
    #[crate::byot(T0 = std::fmt::Display, T1 = serde::Serialize, R = serde::de::DeserializeOwned)]
    pub async fn update(
        &self,
        eval_id: &str,
        request: UpdateEvalRequest,
    ) -> Result<Eval, OpenAIError> {
        self.client
            .post(&format!("/evals/{eval_id}"), request, &self.request_options)
            .await
    }

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