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

use crate::{
    config::Config,
    error::OpenAIError,
    types::{
        CreateFineTuneRequest, FineTune, FineTuneEventsResponseStream, ListFineTuneEventsResponse,
        ListFineTuneResponse,
    },
    Client,
};

/// Manage fine-tuning jobs to tailor a model to your specific training data.
///
/// Related guide: [Fine-tune models](https://platform.openai.com/docs/guides/fine-tuning)
pub struct FineTunes<'c, C: Config> {
    client: &'c Client<C>,
}

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

    /// Creates a job that fine-tunes a specified model from a given dataset.
    ///
    /// Response includes details of the enqueued job including job status and the name of the fine-tuned models once complete.
    ///
    /// [Learn more about Fine-tuning](https://platform.openai.com/docs/guides/fine-tuning)
    pub async fn create(&self, request: CreateFineTuneRequest) -> Result<FineTune, OpenAIError> {
        self.client.post("/fine-tunes", request).await
    }

    /// List your organization's fine-tuning jobs
    pub async fn list(&self) -> Result<ListFineTuneResponse, OpenAIError> {
        self.client.get("/fine-tunes").await
    }

    /// Gets info about the fine-tune job.
    ///
    /// [Learn more about Fine-tuning](https://platform.openai.com/docs/guides/fine-tuning)
    pub async fn retrieve(&self, fine_tune_id: &str) -> Result<FineTune, OpenAIError> {
        self.client
            .get(format!("/fine-tunes/{fine_tune_id}").as_str())
            .await
    }

    /// Immediately cancel a fine-tune job.
    pub async fn cancel(&self, fine_tune_id: &str) -> Result<FineTune, OpenAIError> {
        self.client
            .post(format!("/fine-tunes/{fine_tune_id}/cancel").as_str(), ())
            .await
    }

    /// Get fine-grained status updates for a fine-tune job.
    pub async fn list_events(
        &self,
        fine_tune_id: &str,
    ) -> Result<ListFineTuneEventsResponse, OpenAIError> {
        self.client
            .get(format!("/fine-tunes/{fine_tune_id}/events").as_str())
            .await
    }

    /// Get fine-grained status updates for a fine-tune job.
    ///
    /// Stream fine tuning events. [FineTuneEventsResponseStream] is a parsed SSE
    /// stream until a \[DONE\] is received from server.
    pub async fn list_events_stream(
        &self,
        fine_tune_id: &str,
    ) -> Result<FineTuneEventsResponseStream, OpenAIError> {
        Ok(self
            .client
            .get_stream(
                format!("/fine-tunes/{fine_tune_id}/events").as_str(),
                &[("stream", true)],
            )
            .await)
    }
}