Class FileService

Files Service: https://platform.openai.com/docs/api-reference/files

Inheritance

object

CRUDServiceBase<OpenAI>

FileService

Namespace: Glitch9.AIDevKit.OpenAI.Services

Assembly: .dll

Syntax

public class FileService : CRUDServiceBase<OpenAI>

Constructors

FileService(OpenAI)

Declaration

public FileService(OpenAI client)

Parameters

Type	Name	Description
OpenAI	client

Methods

DeleteAsync(string, RequestOptions)

Declaration

public UniTask<bool> DeleteAsync(string objectId, RequestOptions options = null)

Parameters

Type	Name	Description
string	objectId
RequestOptions	options

Returns

Type	Description
UniTask<bool>

ListAsync(CursorQuery, RequestOptions)

Declaration

public UniTask<QueryResponse<File>> ListAsync(CursorQuery query = null, RequestOptions options = null)

Parameters

Type	Name	Description
CursorQuery	query
RequestOptions	options

Returns

Type	Description
UniTask<QueryResponse<File>>

RetrieveAsync(string, RequestOptions)

Declaration

public UniTask<File> RetrieveAsync(string objectId, RequestOptions options = null)

Parameters

Type	Name	Description
string	objectId
RequestOptions	options

Returns

Type	Description
UniTask<File>

RetrieveFileContentAsync(string, RequestOptions)

Request to retrieve a file from the OpenAI API.

Declaration

public UniTask<FileRef> RetrieveFileContentAsync(string fileId, RequestOptions options = null)

Parameters

Type	Name	Description
string	fileId
RequestOptions	options

Returns

Type	Description
UniTask<FileRef>

UploadAsync(FileUploadRequest)

Request to upload a file to the OpenAI API.

Declaration

public UniTask<File> UploadAsync(FileUploadRequest req)

Parameters

Type	Name	Description
FileUploadRequest	req	The request object to send to the API.

Returns

Type	Description
UniTask<File>	An object containing the FileId.

UploadAsync(FormFile, UploadPurpose)

Request to upload a file to the OpenAI API.

Declaration

public UniTask<File> UploadAsync(FormFile file, UploadPurpose purpose)

Parameters

Type	Name	Description
FormFile	file	The file to upload.
UploadPurpose	purpose	The purpose of the file.

Returns

Type	Description
UniTask<File>	An object containing the FileId.