AssistantData

sttp.openai.requests.assistants.AssistantsResponseData.AssistantData
See theAssistantData companion object
case class AssistantData(id: String, `object`: String, createdAt: Int, name: Option[String], description: Option[String], model: String, instructions: Option[String], tools: Seq[Tool], toolResources: Option[ToolResources], metadata: Map[String, String])

Represents an assistant that can call the model and use tools.

Value parameters

createdAt

The Unix timestamp (in seconds) for when the assistant was created.

description

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

id

The identifier, which can be referenced in API endpoints.

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/object

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.

object

The object type, which is always assistant.

toolResources

A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the code_interpreter tool requires a list of file IDs, while the file_search tool requires a list of vector store IDs.

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, file_search, 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