Class FileService

Namespace

Glitch9.AIDevKit.OpenAI.Services

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

public class FileService : CrudServiceBase<OpenAIClient>

Inheritance

object

FileService

Constructors

FileService(OpenAIClient)

public FileService(OpenAIClient client)

Parameters

client OpenAIClient

Methods

DeleteAsync(string, RESTOptions)

public UniTask<DeletionStatus> DeleteAsync(string objectId, RESTOptions options = null)

Parameters

objectId string

options RESTOptions

Returns

UniTask<DeletionStatus>

DownloadAsync(string, RESTOptions)

public UniTask<FileData> DownloadAsync(string fileId, RESTOptions options = null)

Parameters

fileId string

options RESTOptions

Returns

UniTask<FileData>

ListAsync(CursorQuery, RESTOptions)

public UniTask<QueryResponse<OpenAIFile>> ListAsync(CursorQuery query = null, RESTOptions options = null)

Parameters

query CursorQuery

options RESTOptions

Returns

UniTask<QueryResponse<OpenAIFile>>

RetrieveAsync(string, RESTOptions)

public UniTask<OpenAIFile> RetrieveAsync(string objectId, RESTOptions options = null)

Parameters

objectId string

options RESTOptions

Returns

UniTask<OpenAIFile>

UploadAsync(OpenAIFileUploadRequest, RESTOptions)

public UniTask<OpenAIFile> UploadAsync(OpenAIFileUploadRequest req, RESTOptions options = null)

Parameters

req OpenAIFileUploadRequest

options RESTOptions

Returns

UniTask<OpenAIFile>

UploadAsync(IFile, UploadPurpose, RESTOptions)

public UniTask<OpenAIFile> UploadAsync(IFile file, OpenAITypes.UploadPurpose purpose, RESTOptions options = null)

Parameters

file IFile

purpose OpenAITypes.UploadPurpose

options RESTOptions

Returns

UniTask<OpenAIFile>