java/resources/fine_tuning/subresources/checkpoints/index.md +0 −372 deleted
File Deleted View Diff
1# Checkpoints
2
3# Permissions
4
5## List checkpoint permissions
6
7`PermissionRetrieveResponse fineTuning().checkpoints().permissions().retrieve(PermissionRetrieveParamsparams = PermissionRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())`
8
9**get** `/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions`
10
11**NOTE:** This endpoint requires an [admin API key](../admin-api-keys).
12
13Organization owners can use this endpoint to view all permissions for a fine-tuned model checkpoint.
14
15### Parameters
16
17- `PermissionRetrieveParams params`
18
19 - `Optional<String> fineTunedModelCheckpoint`
20
21 - `Optional<String> after`
22
23 Identifier for the last permission ID from the previous pagination request.
24
25 - `Optional<Long> limit`
26
27 Number of permissions to retrieve.
28
29 - `Optional<Order> order`
30
31 The order in which to retrieve permissions.
32
33 - `ASCENDING("ascending")`
34
35 - `DESCENDING("descending")`
36
37 - `Optional<String> projectId`
38
39 The ID of the project to get permissions for.
40
41### Returns
42
43- `class PermissionRetrieveResponse:`
44
45 - `List<Data> data`
46
47 - `String id`
48
49 The permission identifier, which can be referenced in the API endpoints.
50
51 - `long createdAt`
52
53 The Unix timestamp (in seconds) for when the permission was created.
54
55 - `JsonValue; object_ "checkpoint.permission"constant`
56
57 The object type, which is always "checkpoint.permission".
58
59 - `CHECKPOINT_PERMISSION("checkpoint.permission")`
60
61 - `String projectId`
62
63 The project identifier that the permission is for.
64
65 - `boolean hasMore`
66
67 - `JsonValue; object_ "list"constant`
68
69 - `LIST("list")`
70
71 - `Optional<String> firstId`
72
73 - `Optional<String> lastId`
74
75### Example
76
77```java
78package com.openai.example;
79
80import com.openai.client.OpenAIClient;
81import com.openai.client.okhttp.OpenAIOkHttpClient;
82import com.openai.models.finetuning.checkpoints.permissions.PermissionRetrieveParams;
83import com.openai.models.finetuning.checkpoints.permissions.PermissionRetrieveResponse;
84
85public final class Main {
86 private Main() {}
87
88 public static void main(String[] args) {
89 OpenAIClient client = OpenAIOkHttpClient.fromEnv();
90
91 PermissionRetrieveResponse permission = client.fineTuning().checkpoints().permissions().retrieve("ft-AF1WoRqd3aJAHsqc9NY7iL8F");
92 }
93}
94```
95
96#### Response
97
98```json
99{
100 "data": [
101 {
102 "id": "id",
103 "created_at": 0,
104 "object": "checkpoint.permission",
105 "project_id": "project_id"
106 }
107 ],
108 "has_more": true,
109 "object": "list",
110 "first_id": "first_id",
111 "last_id": "last_id"
112}
113```
114
115## List checkpoint permissions
116
117`PermissionListPage fineTuning().checkpoints().permissions().list(PermissionListParamsparams = PermissionListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())`
118
119**get** `/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions`
120
121**NOTE:** This endpoint requires an [admin API key](../admin-api-keys).
122
123Organization owners can use this endpoint to view all permissions for a fine-tuned model checkpoint.
124
125### Parameters
126
127- `PermissionListParams params`
128
129 - `Optional<String> fineTunedModelCheckpoint`
130
131 - `Optional<String> after`
132
133 Identifier for the last permission ID from the previous pagination request.
134
135 - `Optional<Long> limit`
136
137 Number of permissions to retrieve.
138
139 - `Optional<Order> order`
140
141 The order in which to retrieve permissions.
142
143 - `ASCENDING("ascending")`
144
145 - `DESCENDING("descending")`
146
147 - `Optional<String> projectId`
148
149 The ID of the project to get permissions for.
150
151### Returns
152
153- `class PermissionListResponse:`
154
155 The `checkpoint.permission` object represents a permission for a fine-tuned model checkpoint.
156
157 - `String id`
158
159 The permission identifier, which can be referenced in the API endpoints.
160
161 - `long createdAt`
162
163 The Unix timestamp (in seconds) for when the permission was created.
164
165 - `JsonValue; object_ "checkpoint.permission"constant`
166
167 The object type, which is always "checkpoint.permission".
168
169 - `CHECKPOINT_PERMISSION("checkpoint.permission")`
170
171 - `String projectId`
172
173 The project identifier that the permission is for.
174
175### Example
176
177```java
178package com.openai.example;
179
180import com.openai.client.OpenAIClient;
181import com.openai.client.okhttp.OpenAIOkHttpClient;
182import com.openai.models.finetuning.checkpoints.permissions.PermissionListPage;
183import com.openai.models.finetuning.checkpoints.permissions.PermissionListParams;
184
185public final class Main {
186 private Main() {}
187
188 public static void main(String[] args) {
189 OpenAIClient client = OpenAIOkHttpClient.fromEnv();
190
191 PermissionListPage page = client.fineTuning().checkpoints().permissions().list("ft-AF1WoRqd3aJAHsqc9NY7iL8F");
192 }
193}
194```
195
196#### Response
197
198```json
199{
200 "data": [
201 {
202 "id": "id",
203 "created_at": 0,
204 "object": "checkpoint.permission",
205 "project_id": "project_id"
206 }
207 ],
208 "has_more": true,
209 "object": "list",
210 "first_id": "first_id",
211 "last_id": "last_id"
212}
213```
214
215## Create checkpoint permissions
216
217`PermissionCreatePage fineTuning().checkpoints().permissions().create(PermissionCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())`
218
219**post** `/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions`
220
221**NOTE:** Calling this endpoint requires an [admin API key](../admin-api-keys).
222
223This enables organization owners to share fine-tuned models with other projects in their organization.
224
225### Parameters
226
227- `PermissionCreateParams params`
228
229 - `Optional<String> fineTunedModelCheckpoint`
230
231 - `List<String> projectIds`
232
233 The project identifiers to grant access to.
234
235### Returns
236
237- `class PermissionCreateResponse:`
238
239 The `checkpoint.permission` object represents a permission for a fine-tuned model checkpoint.
240
241 - `String id`
242
243 The permission identifier, which can be referenced in the API endpoints.
244
245 - `long createdAt`
246
247 The Unix timestamp (in seconds) for when the permission was created.
248
249 - `JsonValue; object_ "checkpoint.permission"constant`
250
251 The object type, which is always "checkpoint.permission".
252
253 - `CHECKPOINT_PERMISSION("checkpoint.permission")`
254
255 - `String projectId`
256
257 The project identifier that the permission is for.
258
259### Example
260
261```java
262package com.openai.example;
263
264import com.openai.client.OpenAIClient;
265import com.openai.client.okhttp.OpenAIOkHttpClient;
266import com.openai.models.finetuning.checkpoints.permissions.PermissionCreatePage;
267import com.openai.models.finetuning.checkpoints.permissions.PermissionCreateParams;
268
269public final class Main {
270 private Main() {}
271
272 public static void main(String[] args) {
273 OpenAIClient client = OpenAIOkHttpClient.fromEnv();
274
275 PermissionCreateParams params = PermissionCreateParams.builder()
276 .fineTunedModelCheckpoint("ft:gpt-4o-mini-2024-07-18:org:weather:B7R9VjQd")
277 .addProjectId("string")
278 .build();
279 PermissionCreatePage page = client.fineTuning().checkpoints().permissions().create(params);
280 }
281}
282```
283
284#### Response
285
286```json
287{
288 "data": [
289 {
290 "id": "id",
291 "created_at": 0,
292 "object": "checkpoint.permission",
293 "project_id": "project_id"
294 }
295 ],
296 "has_more": true,
297 "object": "list",
298 "first_id": "first_id",
299 "last_id": "last_id"
300}
301```
302
303## Delete checkpoint permission
304
305`PermissionDeleteResponse fineTuning().checkpoints().permissions().delete(PermissionDeleteParamsparams, RequestOptionsrequestOptions = RequestOptions.none())`
306
307**delete** `/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions/{permission_id}`
308
309**NOTE:** This endpoint requires an [admin API key](../admin-api-keys).
310
311Organization owners can use this endpoint to delete a permission for a fine-tuned model checkpoint.
312
313### Parameters
314
315- `PermissionDeleteParams params`
316
317 - `String fineTunedModelCheckpoint`
318
319 - `Optional<String> permissionId`
320
321### Returns
322
323- `class PermissionDeleteResponse:`
324
325 - `String id`
326
327 The ID of the fine-tuned model checkpoint permission that was deleted.
328
329 - `boolean deleted`
330
331 Whether the fine-tuned model checkpoint permission was successfully deleted.
332
333 - `JsonValue; object_ "checkpoint.permission"constant`
334
335 The object type, which is always "checkpoint.permission".
336
337 - `CHECKPOINT_PERMISSION("checkpoint.permission")`
338
339### Example
340
341```java
342package com.openai.example;
343
344import com.openai.client.OpenAIClient;
345import com.openai.client.okhttp.OpenAIOkHttpClient;
346import com.openai.models.finetuning.checkpoints.permissions.PermissionDeleteParams;
347import com.openai.models.finetuning.checkpoints.permissions.PermissionDeleteResponse;
348
349public final class Main {
350 private Main() {}
351
352 public static void main(String[] args) {
353 OpenAIClient client = OpenAIOkHttpClient.fromEnv();
354
355 PermissionDeleteParams params = PermissionDeleteParams.builder()
356 .fineTunedModelCheckpoint("ft:gpt-4o-mini-2024-07-18:org:weather:B7R9VjQd")
357 .permissionId("cp_zc4Q7MP6XxulcVzj4MZdwsAB")
358 .build();
359 PermissionDeleteResponse permission = client.fineTuning().checkpoints().permissions().delete(params);
360 }
361}
362```
363
364#### Response
365
366```json
367{
368 "id": "id",
369 "deleted": true,
370 "object": "checkpoint.permission"
371}
372```