Skip to content

Commit 589ec49

Browse files
chore(types): define FilePurpose enum (openai#997)
1 parent 19a5ba3 commit 589ec49

File tree

6 files changed

+19
-3
lines changed

6 files changed

+19
-3
lines changed

.stats.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
configured_endpoints: 68
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai-285bce7dcdae7eea5fe84a8d6e5af2c1473d65ea193109370fb2257851eef7eb.yml
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai-8ff62fa1091460d68fbd36d72c17d91b709917bebf2983c9c4de5784bc384a2e.yml

api.md

+1
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@ Types:
7676
- <code><a href="./src/resources/files.ts">FileContent</a></code>
7777
- <code><a href="./src/resources/files.ts">FileDeleted</a></code>
7878
- <code><a href="./src/resources/files.ts">FileObject</a></code>
79+
- <code><a href="./src/resources/files.ts">FilePurpose</a></code>
7980

8081
Methods:
8182

src/index.ts

+1
Original file line numberDiff line numberDiff line change
@@ -277,6 +277,7 @@ export namespace OpenAI {
277277
export import FileContent = API.FileContent;
278278
export import FileDeleted = API.FileDeleted;
279279
export import FileObject = API.FileObject;
280+
export import FilePurpose = API.FilePurpose;
280281
export import FileObjectsPage = API.FileObjectsPage;
281282
export import FileCreateParams = API.FileCreateParams;
282283
export import FileListParams = API.FileListParams;

src/resources/files.ts

+14-1
Original file line numberDiff line numberDiff line change
@@ -183,6 +183,18 @@ export interface FileObject {
183183
status_details?: string;
184184
}
185185

186+
/**
187+
* The intended purpose of the uploaded file.
188+
*
189+
* Use "assistants" for
190+
* [Assistants](https://platform.openai.com/docs/api-reference/assistants) and
191+
* [Message](https://platform.openai.com/docs/api-reference/messages) files,
192+
* "vision" for Assistants image file inputs, "batch" for
193+
* [Batch API](https://platform.openai.com/docs/guides/batch), and "fine-tune" for
194+
* [Fine-tuning](https://platform.openai.com/docs/api-reference/fine-tuning).
195+
*/
196+
export type FilePurpose = 'assistants' | 'batch' | 'fine-tune' | 'vision';
197+
186198
export interface FileCreateParams {
187199
/**
188200
* The File object (not file name) to be uploaded.
@@ -199,7 +211,7 @@ export interface FileCreateParams {
199211
* [Batch API](https://platform.openai.com/docs/guides/batch), and "fine-tune" for
200212
* [Fine-tuning](https://platform.openai.com/docs/api-reference/fine-tuning).
201213
*/
202-
purpose: 'assistants' | 'batch' | 'fine-tune' | 'vision';
214+
purpose: FilePurpose;
203215
}
204216

205217
export interface FileListParams {
@@ -213,6 +225,7 @@ export namespace Files {
213225
export import FileContent = FilesAPI.FileContent;
214226
export import FileDeleted = FilesAPI.FileDeleted;
215227
export import FileObject = FilesAPI.FileObject;
228+
export import FilePurpose = FilesAPI.FilePurpose;
216229
export import FileObjectsPage = FilesAPI.FileObjectsPage;
217230
export import FileCreateParams = FilesAPI.FileCreateParams;
218231
export import FileListParams = FilesAPI.FileListParams;

src/resources/index.ts

+1
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ export {
2727
FileContent,
2828
FileDeleted,
2929
FileObject,
30+
FilePurpose,
3031
FileCreateParams,
3132
FileListParams,
3233
FileObjectsPage,

src/resources/uploads/uploads.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ export interface UploadCreateParams {
143143
* See the
144144
* [documentation on File purposes](https://platform.openai.com/docs/api-reference/files/create#files-create-purpose).
145145
*/
146-
purpose: 'assistants' | 'batch' | 'fine-tune' | 'vision';
146+
purpose: FilesAPI.FilePurpose;
147147
}
148148

149149
export interface UploadCompleteParams {

0 commit comments

Comments
 (0)