OpenAI.File

OpenAI.File

Class Declaration

 Protected Class File
 Inherits OpenAI.Response

Remarks

This class represents an API file response. Refer to the OpenAI documentation on the /v1/files endpoint for further details.

Example

This example uploads a file.

 OpenAI.APIKey = "YOUR KEY HERE"
 Dim f As FolderItem = SpecialFolder.Desktop.Child("training.jsonl")
 Dim file As OpenAI.File = OpenAI.File.Create(f) ' upload

This example downloads a previously-created file.

 OpenAI.APIKey = "YOUR KEY HERE"
 Dim file As OpenAI.File = OpenAI.File.Lookup(0) ' get the first known file
 Dim content As String = file.GetResult() ' download

This example deletes a previously-created file.

 OpenAI.APIKey = "YOUR KEY HERE"
 Dim file As OpenAI.File = OpenAI.File.Lookup(0) ' get the first known file
 file.Delete()

Methods

• Delete
• FinishReason
• GetResult
• GetResultAttribute
• Tokens
• ToString

Properties

• Bytes As Integer
• Created As Date
• ID As String
• Model As OpenAI.Model
• Name As String
• PromptTokenCount As Integer
• Purpose As String
• ReplyTokenCount As Integer
• ResponseFormat As String
• ResultCount As Integer
• ResultType As OpenAI.ResultType
• TokenCount As Integer
• Type As String

Shared methods

• Count
• Create
• IsValid
• Lookup

Shared properties

• Prevalidate As Boolean