Expand description
Files API builders.
This module provides ergonomic builders for OpenAI Files API operations,
including uploading files, managing file metadata, and retrieving file content.
Files are used for various purposes including:
- Training data for fine-tuning
- Documents for assistants and RAG applications
- Images for vision models
Structs§
- File
Delete Builder - Builder for file deletion operations.
- File
List Builder - Builder for file listing operations.
- File
Retrieval Builder - Builder for file retrieval operations.
- File
Upload Builder - Builder for file upload operations.
Enums§
- File
Order - Order for file listing.
- File
Purpose - Purpose for which the file is being uploaded.
Functions§
- delete_
file - Helper function to delete a file.
- list_
files - Helper function to list all files.
- list_
files_ by_ purpose - Helper function to list files with a specific purpose.
- list_
files_ with_ limit - Helper function to list files with a limit.
- retrieve_
file - Helper function to retrieve a file.
- upload_
assistants_ file - Helper function to upload a text file for assistants.
- upload_
file_ from_ path - Helper function to upload a file from a path.
- upload_
fine_ tune_ file - Helper function to upload a text file for fine-tuning.
- upload_
json_ file - Helper function to upload a JSON file.