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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
// src/api/fine_tuning.rs
//! This module defines the `FineTuning` API client, which provides methods
//! for interacting with the `OpenAI` Fine-tuning API.
//!
//! For more details, refer to the [OpenAI Fine-tuning API documentation](https://platform.openai.com/docs/api-reference/fine-tuning).
/// Define a private namespace for all its items.
mod private
{
// Use crate root for base access
use crate::
{
client ::Client,
error ::Result,
environment ::{ OpenaiEnvironment, EnvironmentInterface },
};
use crate::components::fine_tuning_shared::
{
FineTuningJob,
FineTuningJobEvent,
ListFineTuningJobEventsResponse,
ListPaginatedFineTuningJobsResponse,
// FineTuningJobRequest - doesn't exist, need to create or use FineTuningJob
};
use crate::components::common::ListQuery;
// External crates
use serde_json;
use tokio::sync::mpsc;
/// The client for the `OpenAI` Fine-tuning API.
#[ derive( Debug, Clone ) ]
pub struct FineTuning< 'client, E >
where
E : OpenaiEnvironment + EnvironmentInterface + Send + Sync + 'static,
{
client : &'client Client< E >,
}
impl< 'client, E > FineTuning< 'client, E >
where
E : OpenaiEnvironment + EnvironmentInterface + Send + Sync + 'static,
{
/// Creates a new `FineTuning` client.
///
/// # Arguments
/// - `client`: The core `OpenAI` `Client` to use for requests.
#[ inline ]
pub(crate) fn new( client : &'client Client< E > ) -> Self
{
Self { client }
}
/// Creates a fine-tuning job.
///
/// # Arguments
/// - `request`: The request body for creating a fine-tuning job.
///
/// # Errors
/// Returns `OpenAIError` if the request fails.
#[ inline ]
pub async fn create_job( &self, request : FineTuningJob ) -> Result< FineTuningJob >
{
self.client.post( "fine_tuning/jobs", &request ).await
}
/// Lists fine-tuning jobs.
///
/// # Arguments
/// - `query`: Optional query parameters for listing jobs.
///
/// # Errors
/// Returns `OpenAIError` if the request fails.
#[ inline ]
pub async fn list_jobs( &self, query : Option< ListQuery > ) -> Result< ListPaginatedFineTuningJobsResponse >
{
let path = "/fine_tuning/jobs";
if let Some( q ) = query
{
self.client.get_with_query( path, &q ).await
}
else
{
self.client.get( path ).await
}
}
/// Retrieves a fine-tuning job.
///
/// # Arguments
/// - `job_id`: The ID of the fine-tuning job to retrieve.
///
/// # Errors
/// Returns `OpenAIError` if the request fails.
#[ inline ]
pub async fn retrieve_job( &self, job_id : &str ) -> Result< FineTuningJob >
{
let path = format!( "/fine_tuning/jobs/{job_id}" );
self.client.get( &path ).await
}
/// Cancels a fine-tuning job.
///
/// # Arguments
/// - `job_id`: The ID of the fine-tuning job to cancel.
///
/// # Errors
/// Returns `OpenAIError` if the request fails.
#[ inline ]
pub async fn cancel_job( &self, job_id : &str ) -> Result< FineTuningJob >
{
let path = format!( "/fine_tuning/jobs/{job_id}/cancel" );
self.client.post( &path, &serde_json::json!({}) ).await
}
/// Lists events for a fine-tuning job.
///
/// # Arguments
/// - `job_id`: The ID of the fine-tuning job.
/// - `query`: Optional query parameters for listing events.
///
/// # Errors
/// Returns `OpenAIError` if the request fails.
#[ inline ]
pub async fn list_job_events( &self, job_id : &str, query : Option< ListQuery > ) -> Result< ListFineTuningJobEventsResponse >
{
let path = format!( "/fine_tuning/jobs/{job_id}/events" );
if let Some( q ) = query
{
self.client.get_with_query( &path, &q ).await
}
else
{
self.client.get( &path ).await
}
}
/// Streams events for a fine-tuning job.
///
/// # Arguments
/// - `job_id`: The ID of the fine-tuning job.
///
/// # Errors
/// Returns `OpenAIError` if the request fails.
#[ inline ]
pub async fn stream_job_events( &self, job_id : &str ) -> Result< mpsc::Receiver< Result< FineTuningJobEvent > > >
{
let path = format!( "/fine_tuning/jobs/{job_id}/events" );
self.client.post_stream( &path, &serde_json::json!({ "stream": true }) ).await
}
}
} // end mod private
crate ::mod_interface!
{
// Expose all structs defined in this module
exposed use
{
FineTuning,
};
}