assistants: assistants Class
In openaistream: Streaming Capabilities for 'OpenAI API' Interactions
assistants R Documentation
assistants Class
Description
assistants Class
assistants Class
Super class
openaistream::openai -> assistants
Methods
Public methods
-
-
-
-
-
-
-
-
-
-
Inherited methods
Method create()
Create an assistant with a model and instructions.
Usage
assistants$create(model, ..., verbosity = 0)
Arguments
modelcharacter Required. ID of the model to use. You can use the List models API to see all of your available models,
or see our Model overview for descriptions of them.
...Additional parameters as required by the OpenAI API.For example:name;description;instructions;tools;file_ids;metadata
verbositynumeric. Verbosity level for the API call(0:no output;1:show headers;
2:show headers and bodies;3: show headers, bodies, and curl status messages.).
Returns
An assistant object.
Method retrieve()
Retrieves an assistant.
Usage
assistants$retrieve(assistant_id, verbosity = 0)
Arguments
assistant_idcharacter Required. The ID of the assistant to retrieve.
verbositynumeric. Verbosity level for the API call(0:no output;1:show headers;
2:show headers and bodies;3: show headers, bodies, and curl status messages.).
Returns
The assistant object matching the specified ID.
Method modify()
Modifies an assistant.
Usage
assistants$modify(assistant_id, ..., verbosity = 0)
Arguments
assistant_idcharacter Required. The ID of the assistant to modify.
...Additional parameters as required by the OpenAI API.For example:model;name;description;instructions;tools;file_ids,metadata
verbositynumeric. Verbosity level for the API call(0:no output;1:show headers;
2:show headers and bodies;3: show headers, bodies, and curl status messages.).
Returns
The assistant object matching the specified ID.
Method delete()
Delete an assistant.
Usage
assistants$delete(assistant_id, verbosity = 0)
Arguments
assistant_idcharacter Required. The ID of the assistant to delete.
verbositynumeric. Verbosity level for the API call(0:no output;1:show headers;
2:show headers and bodies;3: show headers, bodies, and curl status messages.).
Returns
Deletion status
Method list()
Returns a list of assistants
Usage
assistants$list(..., verbosity = 0)
Arguments
...Additional parameters as required by the OpenAI API.For example:limit;order;after;before;
verbositynumeric. Verbosity level for the API call(0:no output;1:show headers;
2:show headers and bodies;3: show headers, bodies, and curl status messages.).
Returns
A list of assistant objects.
Method file_create()
Create an assistant file by attaching a File to an assistant.
Usage
assistants$file_create(assistant_id, file_id, verbosity = 0)
Arguments
assistant_idcharacter Required. The ID of the assistant for which to create a File.
file_idcharacter Required. A File ID (with purpose="assistants") that the assistant should use.
Useful for tools like retrieval and code_interpreter that can access files.
verbositynumeric. Verbosity level for the API call(0:no output;1:show headers;
2:show headers and bodies;3: show headers, bodies, and curl status messages.).
Returns
An assistant file object.
Method file_retrieve()
Retrieves an AssistantFile.
Usage
assistants$file_retrieve(assistant_id, file_id, verbosity = 0)
Arguments
assistant_idcharacter Required. The ID of the assistant who the file belongs to.
file_idcharacter Required. The ID of the file we're getting.
verbositynumeric. Verbosity level for the API call(0:no output;1:show headers;
2:show headers and bodies;3: show headers, bodies, and curl status messages.).
Returns
The assistant file object matching the specified ID.
Method file_delete()
Delete an assistant file.
Usage
assistants$file_delete(assistant_id, file_id, verbosity = 0)
Arguments
assistant_idcharacter Required. The ID of the assistant who the file belongs to.
file_idcharacter Required. The ID of the file we're getting.
verbositynumeric. Verbosity level for the API call(0:no output;1:show headers;
2:show headers and bodies;3: show headers, bodies, and curl status messages.).
Returns
Deletion status
Method file_list()
Retrieve a list of files from OpenAI.
Usage
assistants$file_list(assistant_id, ..., verbosity = 0)
Arguments
assistant_idcharacter Required. The ID of the assistant who the file belongs to.
...Additional parameters as required by the OpenAI API.For example:limit,order,after,before
verbositynumeric. Verbosity level for the API call(0:no output;1:show headers;
2:show headers and bodies;3: show headers, bodies, and curl status messages.).
Returns
A list of files.
Method clone()
The objects of this class are cloneable with this method.
Usage
assistants$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
openaistream documentation built on June 22, 2024, 9:55 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| assistants | R Documentation |
assistants Class
Description
assistants Class
assistants Class
Super class
openaistream::openai -> assistants
Methods
Public methods
Inherited methods
Method create()
Create an assistant with a model and instructions.
Usage
assistants$create(model, ..., verbosity = 0)
Arguments
modelcharacter Required. ID of the model to use. You can use the List models API to see all of your available models, or see our Model overview for descriptions of them.
...Additional parameters as required by the OpenAI API.For example:name;description;instructions;tools;file_ids;metadata
verbositynumeric. Verbosity level for the API call(0:no output;1:show headers; 2:show headers and bodies;3: show headers, bodies, and curl status messages.).
Returns
An assistant object.
Method retrieve()
Retrieves an assistant.
Usage
assistants$retrieve(assistant_id, verbosity = 0)
Arguments
assistant_idcharacter Required. The ID of the assistant to retrieve.
verbositynumeric. Verbosity level for the API call(0:no output;1:show headers; 2:show headers and bodies;3: show headers, bodies, and curl status messages.).
Returns
The assistant object matching the specified ID.
Method modify()
Modifies an assistant.
Usage
assistants$modify(assistant_id, ..., verbosity = 0)
Arguments
assistant_idcharacter Required. The ID of the assistant to modify.
...Additional parameters as required by the OpenAI API.For example:model;name;description;instructions;tools;file_ids,metadata
verbositynumeric. Verbosity level for the API call(0:no output;1:show headers; 2:show headers and bodies;3: show headers, bodies, and curl status messages.).
Returns
The assistant object matching the specified ID.
Method delete()
Delete an assistant.
Usage
assistants$delete(assistant_id, verbosity = 0)
Arguments
assistant_idcharacter Required. The ID of the assistant to delete.
verbositynumeric. Verbosity level for the API call(0:no output;1:show headers; 2:show headers and bodies;3: show headers, bodies, and curl status messages.).
Returns
Deletion status
Method list()
Returns a list of assistants
Usage
assistants$list(..., verbosity = 0)
Arguments
...Additional parameters as required by the OpenAI API.For example:limit;order;after;before;
verbositynumeric. Verbosity level for the API call(0:no output;1:show headers; 2:show headers and bodies;3: show headers, bodies, and curl status messages.).
Returns
A list of assistant objects.
Method file_create()
Create an assistant file by attaching a File to an assistant.
Usage
assistants$file_create(assistant_id, file_id, verbosity = 0)
Arguments
assistant_idcharacter Required. The ID of the assistant for which to create a File.
file_idcharacter Required. A File ID (with purpose="assistants") that the assistant should use. Useful for tools like retrieval and code_interpreter that can access files.
verbositynumeric. Verbosity level for the API call(0:no output;1:show headers; 2:show headers and bodies;3: show headers, bodies, and curl status messages.).
Returns
An assistant file object.
Method file_retrieve()
Retrieves an AssistantFile.
Usage
assistants$file_retrieve(assistant_id, file_id, verbosity = 0)
Arguments
assistant_idcharacter Required. The ID of the assistant who the file belongs to.
file_idcharacter Required. The ID of the file we're getting.
verbositynumeric. Verbosity level for the API call(0:no output;1:show headers; 2:show headers and bodies;3: show headers, bodies, and curl status messages.).
Returns
The assistant file object matching the specified ID.
Method file_delete()
Delete an assistant file.
Usage
assistants$file_delete(assistant_id, file_id, verbosity = 0)
Arguments
assistant_idcharacter Required. The ID of the assistant who the file belongs to.
file_idcharacter Required. The ID of the file we're getting.
verbositynumeric. Verbosity level for the API call(0:no output;1:show headers; 2:show headers and bodies;3: show headers, bodies, and curl status messages.).
Returns
Deletion status
Method file_list()
Retrieve a list of files from OpenAI.
Usage
assistants$file_list(assistant_id, ..., verbosity = 0)
Arguments
assistant_idcharacter Required. The ID of the assistant who the file belongs to.
...Additional parameters as required by the OpenAI API.For example:limit,order,after,before
verbositynumeric. Verbosity level for the API call(0:no output;1:show headers; 2:show headers and bodies;3: show headers, bodies, and curl status messages.).
Returns
A list of files.
Method clone()
The objects of this class are cloneable with this method.
Usage
assistants$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.