ai.z.openapi.service.file

Interface FileService

All Known Implementing Classes:

FileServiceImpl

public interface FileService

File service interface

Method Summary

Modifier and Type	Method and Description
FileDelResponse	deleteFile(FileDelRequest request) Delete file by file ID.
QueryFileApiResponse	listFiles(FileListParams queryFilesRequest) Lists all files.
HttpxBinaryResponseContent	retrieveFileContent(String fileId) Retrieves the content of a specific file.
FileApiResponse	uploadFile(FileUploadParams request) Uploads a file to the server.

Method Detail

uploadFile

FileApiResponse uploadFile(FileUploadParams request)

Uploads a file to the server.

Parameters:

request - the file upload request

Returns:

FileApiResponse containing the upload result

deleteFile

FileDelResponse deleteFile(FileDelRequest request)

Delete file by file ID.

Parameters:

request - the file id to delete.

Returns:

FileDelResponse containing the delete result

listFiles

QueryFileApiResponse listFiles(FileListParams queryFilesRequest)

Lists all files.

Parameters:

queryFilesRequest - FileListParams containing the query parameters for listing files

Returns:

QueryFileApiResponse containing the list of files

retrieveFileContent

HttpxBinaryResponseContent retrieveFileContent(String fileId)
                                        throws IOException

Retrieves the content of a specific file.

Parameters:

fileId - the ID of the file to retrieve

Returns:

HttpxBinaryResponseContent containing the file content

Throws:

IOException - if an I/O error occurs