Objeck Documentation

All Bundles

Assistant

Builds assistants that can call models and use tools to perform tasks

Operations

AddFile
Create
Delete
DeleteAll
GetCreatedAt
GetDescription
GetId
GetInstructions
GetModel
GetName
GetObject
GetVectorStores
ListAssistants
Load
LoadByName
ToString

AddFile

Adds a file to assistant

method : public : AddFile(file:API.OpenAI.File) ~ Bool

Parameters

Name	Type	Description
file	API.OpenAI.File	file to add to assistant

Return

Type	Description
Bool	true if successful, false otherwise

Create

Create an assistant with a model and instructions

function : Create(model:String, token:String) ~ API.OpenAI.Assistant

Parameters

Name	Type	Description
model	String	ID of the model to use
token	String	API token

Return

Type	Description
API.OpenAI.Assistant	assistant

Create

Create an assistant with a model and instructions

function : Create(model:String, name:String, description:String, instructions:String, token:String) ~ API.OpenAI.Assistant

Parameters

Name	Type	Description
model	String	ID of the model to use
name	String	name to use
description	String	description of the assistant.
instructions	String	the system instructions that the assistant uses
token	String	API token

Return

Type	Description
API.OpenAI.Assistant	newly created assistant

Create

Creates an assistant with a model and instructions

function : Create(model:String, name:String, description:String, instructions:String, tools:Vector<String>, files:Vector<API.OpenAI.File>, token:String) ~ API.OpenAI.Assistant

Parameters

Name	Type	Description
model	String	ID of the model to use
name	String	name to use
description	String	description of the assistant.
instructions	String	the system instructions that the assistant uses
tools	Vector<String>	list of tool enabled on the assistant
files	Vector<APIOpenAIFile>	list of file IDs attached to this assistant
token	String	API token

Return

Type	Description
API.OpenAI.Assistant	newly created assistant

Create

Creates an assistant with a model and instructions

function : Create(model:String, name:String, description:String, instructions:String, tools:Vector<String>, files:Vector<API.OpenAI.File>, funcs:Vector<FunctionType>, token:String) ~ API.OpenAI.Assistant

Parameters

Name	Type	Description
model	String	ID of the model to use
name	String	name to use
description	String	description of the assistant.
instructions	String	the system instructions that the assistant uses
tools	Vector<String>	list of tool enabled on the assistant
files	Vector<APIOpenAIFile>	list of file IDs attached to this assistant
funcs	Vector<FunctionType>	list of callback function definitions
token	String	API token

Return

Type	Description
API.OpenAI.Assistant	newly created assistant

Delete

Deletes an assistant with a model and instructions

function : Delete(id:String, token:String) ~ Bool

Parameters

Name	Type	Description
id	String	model ID
token	String	API token

Return

Type	Description
Bool	true if successful, false otherwise

DeleteAll

Deletes all assistants

function : DeleteAll(token:String) ~ Bool

Parameters

Name	Type	Description
token	String	API token

Return

Type	Description
Bool	true if successful, false otherwise

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

GetDescription

Description of the assistant

method : public : GetDescription() ~ String

Return

Type	Description
String	description of the assistant

GetId

Get object instance API ID

method : public : GetId() ~ String

Return

Type	Description
String	instance ID

GetInstructions

System instructions that the assistant uses

method : public : GetInstructions() ~ String

Return

Type	Description
String	system instructions

GetModel

ID of the model to use

method : public : GetModel() ~ String

Return

Type	Description
String	ID of the model to use

GetName

Name of the assistant

method : public : GetName() ~ String

Return

Type	Description
String	name of the assistant

GetObject

Get the object type

method : public : GetObject() ~ String

Return

Type	Description
String	object type

GetVectorStores

List of vector stores associated with the assistant

method : public : GetVectorStores() ~ Vector<String>

Return

Type	Description
Vector<String>	vector stores associated with the assistant

ListAssistants

Returns a list of assistants

function : ListAssistants(token:String) ~ Vector<API.OpenAI.Assistant>

Parameters

Name	Type	Description
token	String	API token

Return

Type	Description
Vector<APIOpenAIAssistant>	list of assistants

Load

Loads an assistant with a model and instructions

function : Load(id:String, token:String) ~ API.OpenAI.Assistant

Parameters

Name	Type	Description
id	String	model ID of the model to use
token	String	API token

Return

Type	Description
API.OpenAI.Assistant	loaded assistant

LoadByName

Loads or creates an OpenAI file from the local filesystem

function : LoadByName(name:String, token:String) ~ API.OpenAI.Assistant

Parameters

Name	Type	Description
name	String	name lookup
token	String	API token

Return

Type	Description
API.OpenAI.Assistant	file reference

ToString

String representation of the object

method : public : ToString() ~ String

Return

Type	Description
String	string representation