All Bundles
Assistant
Builds assistants that can call models and use tools to perform tasks
Derived from: EndPoint
Operations
AddFile
Adds a file to assistant
method : public : AddFile(file:API.OpenAI.File) ~ BoolParameters
| Name | Type | Description |
|---|
| file | 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.AssistantParameters
| Name | Type | Description |
|---|
| model | String | ID of the model to use |
| token | String | API token |
Return
Create an assistant with a model and instructions
function : Create(model:String, name:String, description:String, instructions:String, token:String) ~ API.OpenAI.AssistantParameters
| 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 |
|---|
| Assistant | newly created assistant |
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.AssistantParameters
| 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 | File<> | list of file IDs attached to this assistant |
| token | String | API token |
Return
| Type | Description |
|---|
| Assistant | newly created assistant |
Delete
Deletes an assistant with a model and instructions
function : Delete(id:String, token:String) ~ BoolParameters
| Name | Type | Description |
|---|
| id | String | model ID of the model to use |
| 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() ~ IntReturn
| Type | Description |
|---|
| Int | time with the object instance was created |
GetDescription
Description of the assistant
method : public : GetDescription() ~ StringReturn
| Type | Description |
|---|
| String | description of the assistant |
GetId
Get object instance API ID
method : public : GetId() ~ StringReturn
| Type | Description |
|---|
| String | instance ID |
GetInstructions
System instructions that the assistant uses
method : public : GetInstructions() ~ StringReturn
| Type | Description |
|---|
| String | system instructions |
GetModel
ID of the model to use
method : public : GetModel() ~ StringReturn
| Type | Description |
|---|
| String | ID of the model to use |
GetName
Name of the assistant
method : public : GetName() ~ StringReturn
| Type | Description |
|---|
| String | name of the assistant |
GetObject
Get the object type
method : public : GetObject() ~ StringReturn
| Type | Description |
|---|
| String | object type |
ListAssistants
Returns a list of assistants
function : ListAssistants(token:String) ~ Vector<API.OpenAI.Assistant>Parameters
| Name | Type | Description |
|---|
| token | String | API token |
Return
Load
Loads an assistant with a model and instructions
function : Load(id:String, token:String) ~ API.OpenAI.AssistantParameters
| Name | Type | Description |
|---|
| id | String | model ID of the model to use |
| token | String | API token |
Return
ToString
String representation of the object
method : public : ToString() ~ StringReturn
| Type | Description |
|---|
| String | string representation |