All Bundles
File
Open AI file
Derived from: EndPoint
Operations
Create
Upload a file that can be used across various endpoints
function : Create(name:String, content:Byte[], token:String) ~ Bool
Parameters
Name | Type | Description |
---|
name | String | file object name |
content | Byte[] | file content |
token | String | API token |
Return
Type | Description |
---|
Bool | string representation |
Delete
Deletes a file
function : Delete(id:String, token:String) ~ Bool
Parameters
Return
Type | Description |
---|
Bool | true if successful, false otherwise |
GetBytes
Get the size of the file
method : public : GetBytes() ~ Int
Return
Type | Description |
---|
Int | size of the file |
GetCreatedAt
Unix timestamp (in seconds) of when the object instance was created
method : public : GetCreatedAt() ~ Int
Return
Type | Description |
---|
Int | time with the object instance was created |
GetFilename
Get the name of the file
method : public : GetFilename() ~ String
Return
Type | Description |
---|
String | name of the file |
GetId
Get object instance API ID
method : public : GetId() ~ String
Return
Type | Description |
---|
String | instance ID |
GetObject
Get the object type
method : public : GetObject() ~ String
Return
Type | Description |
---|
String | object type |
GetPurpose
Get the purpose
method : public : GetPurpose() ~ String
Return
ListFiles
Loads a list available OpenAI files
function : ListFiles(token:String) ~ Vector<API.OpenAI.File>
Parameters
Name | Type | Description |
---|
token | String | API token |
Return
Type | Description |
---|
File<> | file reference |
Load
Loads a file
function : Load(id:String, token:String) ~ API.OpenAI.File
Parameters
Return
Type | Description |
---|
File | file reference |
LoadByName
Loads an OpenAI file from the local filesystem
function : LoadByName(filename:String, token:String) ~ API.OpenAI.File
Parameters
Name | Type | Description |
---|
filename | String | local file path |
token | String | API token |
Return
Type | Description |
---|
File | file reference |
LoadOrCreate
Loads or creates an OpenAI file from the local filesystem
function : LoadOrCreate(filename:String, token:String) ~ API.OpenAI.File
Parameters
Name | Type | Description |
---|
filename | String | local file path |
token | String | API token |
Return
Type | Description |
---|
File | file reference |
Retrieve
Returns the contents of the specified file
function : Retrieve(id:String, token:String) ~ Byte[]
Parameters
Return
Type | Description |
---|
Byte[] | file content |
ToString
String representation of the object
method : public : ToString() ~ String
Return
Type | Description |
---|
String | string representation |