CreateAssistantBody

sttp.openai.requests.assistants.AssistantsRequestBody.CreateAssistantBody
See theCreateAssistantBody companion object
case class CreateAssistantBody(model: String, name: Option[String], description: Option[String], instructions: Option[String], tools: Seq[Tool], file_ids: Seq[String], metadata: Option[Map[String, String]])

Value parameters

description

The description of the assistant. The maximum length is 512 characters.

file_ids

A list of file IDs attached to this assistant. There can be a maximum of 20 files attached to the assistant. Files are ordered by their creation date in ascending order.

instructions

The system instructions that the assistant uses. The maximum length is 32768 characters.

metadata

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long. For more information please visit: https://platform.openai.com/docs/api-reference/assistants/createAssistant

model

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.

name

The name of the assistant. The maximum length is 256 characters.

tools

A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types code_interpreter, retrieval, or function.

Attributes

Companion
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product