final case class AssistantObject(id: String, object: AssistantObject.Object, createdAt: Int, name: Optional[Name], description: Optional[Description], model: String, instructions: Optional[Instructions], tools: Chunk[ToolsItem], fileIds: Chunk[String], metadata: Optional[Metadata]) extends Product with Serializable
AssistantObject model
Represents an assistant that can call the model and use tools.
- id
The identifier, which can be referenced in API endpoints.
- object
The object type, which is always
assistant.- createdAt
The Unix timestamp (in seconds) for when the assistant was created.
- name
The name of the assistant. The maximum length is 256 characters.
- description
The description of the assistant. The maximum length is 512 characters.
- model
ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models/overview) for descriptions of them.
- instructions
The system instructions that the assistant uses. The maximum length is 32768 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, orfunction.- fileIds
A list of [file](/docs/api-reference/files) 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.
- 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.
- Alphabetic
- By Inheritance
- AssistantObject
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new AssistantObject(id: String, object: AssistantObject.Object, createdAt: Int, name: Optional[Name], description: Optional[Description], model: String, instructions: Optional[Instructions], tools: Chunk[ToolsItem], fileIds: Chunk[String], metadata: Optional[Metadata])
- id
The identifier, which can be referenced in API endpoints.
- object
The object type, which is always
assistant.- createdAt
The Unix timestamp (in seconds) for when the assistant was created.
- name
The name of the assistant. The maximum length is 256 characters.
- description
The description of the assistant. The maximum length is 512 characters.
- model
ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models/overview) for descriptions of them.
- instructions
The system instructions that the assistant uses. The maximum length is 32768 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, orfunction.- fileIds
A list of [file](/docs/api-reference/files) 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.
- 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.
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- val createdAt: Int
- val description: Optional[Description]
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val fileIds: Chunk[String]
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- val id: String
- val instructions: Optional[Instructions]
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val metadata: Optional[Metadata]
- val model: String
- val name: Optional[Name]
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val object: AssistantObject.Object
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val tools: Chunk[ToolsItem]
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()