Module files

Module files 

Source
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§

FileDeleteBuilder
Builder for file deletion operations.
FileListBuilder
Builder for file listing operations.
FileRetrievalBuilder
Builder for file retrieval operations.
FileUploadBuilder
Builder for file upload operations.

Enums§

FileOrder
Order for file listing.
FilePurpose
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.