FilesOperations Class

Constructor

FilesOperations(*args, **kwargs)

Methods

delete	Delete a previously uploaded file.
get	Returns information about a specific file. Does not retrieve file content.
get_content	Returns file content as byte stream for given file_id.
list	Gets a list of previously uploaded files.
save	Synchronously saves file content retrieved using a file identifier to the specified local directory.
upload	Uploads a file for use by other operations, delegating to the generated operations.
upload_and_poll	Uploads a file for use by other operations, delegating to the generated operations.

delete

Delete a previously uploaded file.

delete(file_id: str, **kwargs: Any) -> None

Parameters

Name	Description
file_id Required	str The ID of the file to delete.

Returns

Type	Description
None

Exceptions

Type	Description
HttpResponseError

get

Returns information about a specific file. Does not retrieve file content.

get(file_id: str, **kwargs: Any) -> FileInfo

Parameters

Name	Description
file_id Required	str The ID of the file to retrieve. Required.

Returns

Type	Description
FileInfo	FileInfo. The FileInfo is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

get_content

Returns file content as byte stream for given file_id.

get_content(file_id: str, **kwargs: Any) -> Iterator[bytes]

Parameters

Name	Description
file_id Required	str The ID of the file to retrieve.

Returns

Type	Description
Iterator[bytes]	An iterator that yields bytes from the file content.

Exceptions

Type	Description
HttpResponseError	If the HTTP request fails.

list

Gets a list of previously uploaded files.

list(*, purpose: str | FilePurpose | None = None, **kwargs: Any) -> FileListResponse

Keyword-Only Parameters

Name	Description
purpose	str or FilePurpose The purpose of the file. Known values are: "assistants", "assistants_output", and "vision". Default value is None. Default value: None

Returns

Type	Description
FileListResponse	FileListResponse. The FileListResponse is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

save

Synchronously saves file content retrieved using a file identifier to the specified local directory.

save(file_id: str, file_name: str, target_dir: str | Path | None = None) -> None

Parameters

Name	Description
file_id Required	str The unique identifier for the file to retrieve.
file_name Required	str The name of the file to be saved.
target_dir	Optional[Union[str, <xref:Path>]] The directory where the file should be saved. Defaults to the current working directory. Default value: None

Exceptions

Type	Description
ValueError	If the target path is not a directory or the file name is invalid.
RuntimeError	If file content retrieval fails or no content is found.
TypeError	If retrieved chunks are not bytes-like objects.
IOError	If writing to the file fails.

upload

Uploads a file for use by other operations, delegating to the generated operations.

upload(*, file_path: str, purpose: str | _models.FilePurpose, **kwargs: Any) -> _models.FileInfo

Parameters

Name	Description
body	Optional[<xref:JSON>] JSON. Required if file and purpose are not provided. Default value: None

Keyword-Only Parameters

Name	Description
file	Optional[<xref:FileType>] File content. Required if body and purpose are not provided. Default value: None
file_path	Optional[str] Path to the file. Required if body and purpose are not provided. Default value: None
purpose	Union[str, <xref:_models.FilePurpose>, None] Known values are: "assistants", "assistants_output", and "vision". Required if body and file are not provided. Default value: None
filename	Optional[str] The name of the file. Default value: None

Returns

Type	Description
FileInfo	FileInfo. The FileInfo is compatible with MutableMapping

Exceptions

Type	Description
FileNotFoundError	If the file_path is invalid.
IOError	If there are issues with reading the file.
HttpResponseError for HTTP errors.

upload_and_poll

Uploads a file for use by other operations, delegating to the generated operations.

upload_and_poll(body: JSON, *, polling_interval: float = 1, timeout: float | None = None, **kwargs: Any) -> _models.FileInfo

Parameters

Name	Description
body	Optional[<xref:JSON>] JSON. Required if file and purpose are not provided. Default value: None

Keyword-Only Parameters

Name	Description
file	Optional[<xref:FileType>] File content. Required if body and purpose are not provided. Default value: None
file_path	Optional[str] Path to the file. Required if body and purpose are not provided. Default value: None
purpose	Union[str, <xref:_models.FilePurpose>, None] Known values are: "assistants", "assistants_output", and "vision". Required if body and file are not provided. Default value: None
filename	Optional[str] The name of the file. Default value: None
polling_interval	float Time to wait before polling for the status of the uploaded file. Default value is 1. Default value: 1
timeout	float Time to wait before polling for the status of the uploaded file. Default value: None

Returns

Type	Description
FileInfo	FileInfo. The FileInfo is compatible with MutableMapping

Exceptions

Type	Description
FileNotFoundError	If the file_path is invalid.
IOError	If there are issues with reading the file.
TimeoutError	If the operation times out while polling for status.
HttpResponseError for HTTP errors.