All Bundles

VectorStoreFile

Vector store files represent files inside a vector store

Derived from: EndPoint

Operations

Code example:

store := API.OpenAI.VectorStore->Load(store_id, token);
file := API.OpenAI.File->Load(file_id, token);
if(store <> Nil & file <> Nil) {
  VectorStoreFile->Create(file, store, token)->ToString()->PrintLine();
};

Create

Create a vector store

function : Create(file:API.OpenAI.File, store:VectorStore, token:String) ~ VectorStoreFile
Parameters
NameTypeDescription
fileFilefile to add to store
storeVectorStorestore to add file to
tokenStringAPI token

Return
TypeDescription
VectorStoreFilevector store file

Delete

Deletes a file store

function : Delete(store_file_id:String, store:VectorStore, token:String) ~ Bool
Parameters
NameTypeDescription
store_file_idStringvector store file ID
storeVectorStorevector store that the files belong to
tokenStringAPI token

Return
TypeDescription
Booltrue if successful, false otherwise

GetBytes

Get the store's usage in bytes

method : public : GetBytes() ~ Int
Return
TypeDescription
Intstore's usage in bytes

GetCreatedAt

Unix timestamp (in seconds) of when the object instance was created

method : public : GetCreatedAt() ~ Int
Return
TypeDescription
Inttime with the object instance was created

GetId

Get object instance API ID

method : public : GetId() ~ String
Return
TypeDescription
Stringinstance ID

GetObject

Get the object type

method : public : GetObject() ~ String
Return
TypeDescription
Stringobject type

GetStatus

Get the store's status

method : public : GetStatus() ~ String
Return
TypeDescription
Stringstore's status

GetVectorStore

Get vector store

method : public : GetVectorStore() ~ VectorStore
Return
TypeDescription
VectorStorevector store

ListStoreFiles

Lists vector store files

function : ListStoreFiles(store:VectorStore, token:String) ~ Vector<VectorStoreFile>
Parameters
NameTypeDescription
storeVectorStorevector store that the files belong to
tokenStringAPI token

Return
TypeDescription
Vector<VectorStoreFile>list of vector store files

Load

Loads vector store file

function : Load(store_file_id:String, store:VectorStore, token:String) ~ VectorStoreFile
Parameters
NameTypeDescription
store_file_idStringvector store file ID
storeVectorStorevector store that the files belong to
tokenStringAPI token

Return
TypeDescription
VectorStoreFilestore file

ToString

String representation of the object

method : public : ToString() ~ String
Return
TypeDescription
Stringstring representation