openai_dive 1.4.3

OpenAI Dive is an unofficial async Rust library that allows you to interact with the OpenAI API.
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

use crate::v1::api::Client;
use crate::v1::error::APIError;
use crate::v1::helpers::format_response;
use crate::v1::resources::fine_tuning::CreateFineTuningJobParameters;
use crate::v1::resources::fine_tuning::FineTuningJob;
use crate::v1::resources::fine_tuning::FineTuningJobCheckpoint;
use crate::v1::resources::fine_tuning::FineTuningJobEvent;
use crate::v1::resources::shared::ListResponse;
use crate::v1::resources::shared::SimpleListParameters;
use serde_json::Value;

pub struct FineTuning<'a> {
    pub client: &'a Client,
}

impl Client {
    /// Manage fine-tuning jobs to tailor a model to your specific training data.
    pub fn fine_tuning(&self) -> FineTuning<'_> {
        FineTuning { client: self }
    }
}

impl FineTuning<'_> {
    /// Creates a job that fine-tunes a specified model from a given dataset.
    pub async fn create(
        &self,
        parameters: CreateFineTuningJobParameters,
    ) -> Result<FineTuningJob, APIError> {
        let response = self
            .client
            .post("/fine_tuning/jobs", &parameters, None)
            .await?;

        let response: FineTuningJob = format_response(response.data)?;

        Ok(response)
    }

    /// List your organization's fine-tuning jobs.
    pub async fn list(
        &self,
        query: Option<SimpleListParameters>,
    ) -> Result<ListResponse<FineTuningJob>, APIError> {
        let response = self
            .client
            .get_with_query("/fine_tuning/jobs", &query)
            .await?;

        let response: ListResponse<FineTuningJob> = format_response(response)?;

        Ok(response)
    }

    /// Get info about a fine-tuning job.
    pub async fn retrieve(&self, id: &str) -> Result<FineTuningJob, APIError> {
        let response = self.client.get(&format!("/fine_tuning/jobs/{id}")).await?;

        let response: FineTuningJob = format_response(response)?;

        Ok(response)
    }

    /// Immediately cancel a fine-tune job.
    pub async fn cancel(&self, id: &str) -> Result<FineTuningJob, APIError> {
        let response = self
            .client
            .post(
                &format!("/fine_tuning/jobs/{id}/cancel"),
                &Value::Null,
                None,
            )
            .await?;

        let response: FineTuningJob = format_response(response.data)?;

        Ok(response)
    }

    /// Get status updates for a fine-tuning job.
    pub async fn list_job_events(
        &self,
        id: &str,
        query: Option<SimpleListParameters>,
    ) -> Result<ListResponse<FineTuningJobEvent>, APIError> {
        let response = self
            .client
            .get_with_query(&format!("/fine_tuning/jobs/{id}/events"), &query)
            .await?;

        let response: ListResponse<FineTuningJobEvent> = format_response(response)?;

        Ok(response)
    }

    /// List checkpoints for a fine-tuning job.
    pub async fn list_checkpoints(
        &self,
        id: &str,
        query: Option<SimpleListParameters>,
    ) -> Result<ListResponse<FineTuningJobCheckpoint>, APIError> {
        let response = self
            .client
            .get_with_query(&format!("/fine_tuning/jobs/{id}/checkpoints"), &query)
            .await?;

        let response: ListResponse<FineTuningJobCheckpoint> = format_response(response)?;

        Ok(response)
    }
}