python/resources/models/index.md +0 −284 deleted
File Deleted View Diff
1# Models
2
3## List models
4
5`models.list() -> SyncPage[Model]`
6
7**get** `/models`
8
9Lists the currently available models, and provides basic information about each one such as the owner and availability.
10
11### Returns
12
13- `class Model: …`
14
15 Describes an OpenAI model offering that can be used with the API.
16
17 - `id: str`
18
19 The model identifier, which can be referenced in the API endpoints.
20
21 - `created: int`
22
23 The Unix timestamp (in seconds) when the model was created.
24
25 - `object: Literal["model"]`
26
27 The object type, which is always "model".
28
29 - `"model"`
30
31 - `owned_by: str`
32
33 The organization that owns the model.
34
35### Example
36
37```python
38import os
39from openai import OpenAI
40
41client = OpenAI(
42 api_key=os.environ.get("OPENAI_API_KEY"), # This is the default and can be omitted
43)
44page = client.models.list()
45page = page.data[0]
46print(page.id)
47```
48
49#### Response
50
51```json
52{
53 "data": [
54 {
55 "id": "id",
56 "created": 0,
57 "object": "model",
58 "owned_by": "owned_by"
59 }
60 ],
61 "object": "list"
62}
63```
64
65### Example
66
67```python
68from openai import OpenAI
69client = OpenAI()
70
71client.models.list()
72```
73
74#### Response
75
76```json
77{
78 "object": "list",
79 "data": [
80 {
81 "id": "model-id-0",
82 "object": "model",
83 "created": 1686935002,
84 "owned_by": "organization-owner"
85 },
86 {
87 "id": "model-id-1",
88 "object": "model",
89 "created": 1686935002,
90 "owned_by": "organization-owner",
91 },
92 {
93 "id": "model-id-2",
94 "object": "model",
95 "created": 1686935002,
96 "owned_by": "openai"
97 },
98 ]
99}
100```
101
102## Retrieve model
103
104`models.retrieve(strmodel) -> Model`
105
106**get** `/models/{model}`
107
108Retrieves a model instance, providing basic information about the model such as the owner and permissioning.
109
110### Parameters
111
112- `model: str`
113
114### Returns
115
116- `class Model: …`
117
118 Describes an OpenAI model offering that can be used with the API.
119
120 - `id: str`
121
122 The model identifier, which can be referenced in the API endpoints.
123
124 - `created: int`
125
126 The Unix timestamp (in seconds) when the model was created.
127
128 - `object: Literal["model"]`
129
130 The object type, which is always "model".
131
132 - `"model"`
133
134 - `owned_by: str`
135
136 The organization that owns the model.
137
138### Example
139
140```python
141import os
142from openai import OpenAI
143
144client = OpenAI(
145 api_key=os.environ.get("OPENAI_API_KEY"), # This is the default and can be omitted
146)
147model = client.models.retrieve(
148 "gpt-4o-mini",
149)
150print(model.id)
151```
152
153#### Response
154
155```json
156{
157 "id": "id",
158 "created": 0,
159 "object": "model",
160 "owned_by": "owned_by"
161}
162```
163
164### Example
165
166```python
167from openai import OpenAI
168client = OpenAI()
169
170client.models.retrieve("VAR_chat_model_id")
171```
172
173#### Response
174
175```json
176{
177 "id": "VAR_chat_model_id",
178 "object": "model",
179 "created": 1686935002,
180 "owned_by": "openai"
181}
182```
183
184## Delete a fine-tuned model
185
186`models.delete(strmodel) -> ModelDeleted`
187
188**delete** `/models/{model}`
189
190Delete a fine-tuned model. You must have the Owner role in your organization to delete a model.
191
192### Parameters
193
194- `model: str`
195
196### Returns
197
198- `class ModelDeleted: …`
199
200 - `id: str`
201
202 - `deleted: bool`
203
204 - `object: str`
205
206### Example
207
208```python
209import os
210from openai import OpenAI
211
212client = OpenAI(
213 api_key=os.environ.get("OPENAI_API_KEY"), # This is the default and can be omitted
214)
215model_deleted = client.models.delete(
216 "ft:gpt-4o-mini:acemeco:suffix:abc123",
217)
218print(model_deleted.id)
219```
220
221#### Response
222
223```json
224{
225 "id": "id",
226 "deleted": true,
227 "object": "object"
228}
229```
230
231### Example
232
233```python
234from openai import OpenAI
235client = OpenAI()
236
237client.models.delete("ft:gpt-4o-mini:acemeco:suffix:abc123")
238```
239
240#### Response
241
242```json
243{
244 "id": "ft:gpt-4o-mini:acemeco:suffix:abc123",
245 "object": "model",
246 "deleted": true
247}
248```
249
250## Domain Types
251
252### Model
253
254- `class Model: …`
255
256 Describes an OpenAI model offering that can be used with the API.
257
258 - `id: str`
259
260 The model identifier, which can be referenced in the API endpoints.
261
262 - `created: int`
263
264 The Unix timestamp (in seconds) when the model was created.
265
266 - `object: Literal["model"]`
267
268 The object type, which is always "model".
269
270 - `"model"`
271
272 - `owned_by: str`
273
274 The organization that owns the model.
275
276### Model Deleted
277
278- `class ModelDeleted: …`
279
280 - `id: str`
281
282 - `deleted: bool`
283
284 - `object: str`