Packages

final case class MessageObject(id: String, object: Object, createdAt: Int, threadId: String, role: Role, content: Chunk[ContentItem], assistantId: Optional[String], runId: Optional[String], fileIds: Chunk[String], metadata: Optional[Metadata]) extends Product with Serializable

MessageObject model

Represents a message within a [thread](/docs/api-reference/threads).

id

The identifier, which can be referenced in API endpoints.

object

The object type, which is always thread.message.

createdAt

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

threadId

The [thread](/docs/api-reference/threads) ID that this message belongs to.

role

The entity that produced the message. One of user or assistant.

content

The content of the message in array of text and/or images.

assistantId

If applicable, the ID of the [assistant](/docs/api-reference/assistants) that authored this message.

runId

If applicable, the ID of the [run](/docs/api-reference/runs) associated with the authoring of this message.

fileIds

A list of [file](/docs/api-reference/files) IDs that the assistant should use. Useful for tools like retrieval and code_interpreter that can access files. A maximum of 10 files can be attached to a message.

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.

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MessageObject
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new MessageObject(id: String, object: Object, createdAt: Int, threadId: String, role: Role, content: Chunk[ContentItem], assistantId: Optional[String], runId: Optional[String], fileIds: Chunk[String], metadata: Optional[Metadata])

    id

    The identifier, which can be referenced in API endpoints.

    object

    The object type, which is always thread.message.

    createdAt

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

    threadId

    The [thread](/docs/api-reference/threads) ID that this message belongs to.

    role

    The entity that produced the message. One of user or assistant.

    content

    The content of the message in array of text and/or images.

    assistantId

    If applicable, the ID of the [assistant](/docs/api-reference/assistants) that authored this message.

    runId

    If applicable, the ID of the [run](/docs/api-reference/runs) associated with the authoring of this message.

    fileIds

    A list of [file](/docs/api-reference/files) IDs that the assistant should use. Useful for tools like retrieval and code_interpreter that can access files. A maximum of 10 files can be attached to a message.

    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

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val assistantId: Optional[String]
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  7. val content: Chunk[ContentItem]
  8. val createdAt: Int
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. val fileIds: Chunk[String]
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  12. val id: String
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. val metadata: Optional[Metadata]
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  18. val object: Object
  19. def productElementNames: Iterator[String]
    Definition Classes
    Product
  20. val role: Role
  21. val runId: Optional[String]
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. val threadId: String
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped