Class FileService

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

Inheritance

object

CRUDServiceBase<OpenAI>

FileService

Inherited Members

CRUDServiceBase<OpenAI>.client

CRUDServiceBase<OpenAI>.IsBetaService

CRUDServiceBase<OpenAI>.CustomApiKey

CRUDServiceBase<OpenAI>.CustomBetaHeaders

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, RESTRequestOptions)

Declaration

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

Parameters

Type	Name	Description
string	objectId
RESTRequestOptions	options

Returns

Type	Description
UniTask<bool>

DownloadAsync(string, RESTRequestOptions)

Declaration

public UniTask<FileContentData> DownloadAsync(string fileId, RESTRequestOptions options = null)

Parameters

Type	Name	Description
string	fileId
RESTRequestOptions	options

Returns

Type	Description
UniTask<FileContentData>

ListAsync(CursorQuery, RESTRequestOptions)

Declaration

public UniTask<RESTQueryResponse<OpenAIFile>> ListAsync(CursorQuery query = null, RESTRequestOptions options = null)

Parameters

Type	Name	Description
CursorQuery	query
RESTRequestOptions	options

Returns

Type	Description
UniTask<RESTQueryResponse<OpenAIFile>>

RetrieveAsync(string, RESTRequestOptions)

Declaration

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

Parameters

Type	Name	Description
string	objectId
RESTRequestOptions	options

Returns

Type	Description
UniTask<OpenAIFile>

UploadAsync(OpenAIUploadRequest)

Declaration

public UniTask<OpenAIFile> UploadAsync(OpenAIUploadRequest req)

Parameters

Type	Name	Description
OpenAIUploadRequest	req

Returns

Type	Description
UniTask<OpenAIFile>

UploadAsync(IFile, UploadPurpose)

Declaration

public UniTask<OpenAIFile> UploadAsync(IFile file, OpenAITypes.UploadPurpose purpose)

Parameters

Type	Name	Description
IFile	file
OpenAITypes.UploadPurpose	purpose

Returns

Type	Description
UniTask<OpenAIFile>