Class FileService

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

Inheritance
object
CrudServiceBase<OpenAIClient>
FileService
Implements
Inherited Members
Namespace: Glitch9.AIDevKit.OpenAI.Services
Assembly: Glitch9.AIDevKit.Provider.OpenAI.dll
Syntax
public sealed class FileService : CrudServiceBase<OpenAIClient>, ICrudService

Constructors

| Edit this page View Source

FileService(OpenAIClient)

Declaration
public FileService(OpenAIClient client)
Parameters
Type Name Description
OpenAIClient client

Methods

| Edit this page View Source

DeleteAsync(string, RequestOptions)

Declaration
public UniTask<DeletionStatus> DeleteAsync(string objectId, RequestOptions options = null)
Parameters
Type Name Description
string objectId
RequestOptions options
Returns
Type Description
UniTask<DeletionStatus>
| Edit this page View Source

DownloadAsync(string, RequestOptions)

Declaration
public UniTask<FileContentData> DownloadAsync(string fileId, RequestOptions options = null)
Parameters
Type Name Description
string fileId
RequestOptions options
Returns
Type Description
UniTask<FileContentData>
| Edit this page View Source

ListAsync(CursorQuery, RequestOptions)

Declaration
public UniTask<Queried<OpenAIFile>> ListAsync(CursorQuery query = null, RequestOptions options = null)
Parameters
Type Name Description
CursorQuery query
RequestOptions options
Returns
Type Description
UniTask<Queried<OpenAIFile>>
| Edit this page View Source

RetrieveAsync(string, RequestOptions)

Declaration
public UniTask<OpenAIFile> RetrieveAsync(string objectId, RequestOptions options = null)
Parameters
Type Name Description
string objectId
RequestOptions options
Returns
Type Description
UniTask<OpenAIFile>
| Edit this page View Source

UploadAsync(AIFileUploadRequest, RequestOptions)

Declaration
public UniTask<OpenAIFile> UploadAsync(AIFileUploadRequest request, RequestOptions options = null)
Parameters
Type Name Description
AIFileUploadRequest request
RequestOptions options
Returns
Type Description
UniTask<OpenAIFile>
| Edit this page View Source

UploadAsync(IFile, UploadPurpose, RequestOptions)

Declaration
public UniTask<OpenAIFile> UploadAsync(IFile file, UploadPurpose purpose, RequestOptions options = null)
Parameters
Type Name Description
IFile file
UploadPurpose purpose
RequestOptions options
Returns
Type Description
UniTask<OpenAIFile>

Implements

Extension Methods