Packages

final case class RunObject(id: String, object: Object, createdAt: Int, threadId: String, assistantId: String, status: Status, requiredAction: Optional[RequiredAction], lastError: Optional[LastError], expiresAt: Int, startedAt: Optional[Int], cancelledAt: Optional[Int], failedAt: Optional[Int], completedAt: Optional[Int], model: String, instructions: String, tools: Chunk[ToolsItem], fileIds: Chunk[String], metadata: Optional[Metadata], usage: RunCompletionUsage) extends Product with Serializable

RunObject model

Represents an execution run on a [thread](/docs/api-reference/threads).

id

The identifier, which can be referenced in API endpoints.

object

The object type, which is always thread.run.

createdAt

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

threadId

The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run.

assistantId

The ID of the [assistant](/docs/api-reference/assistants) used for execution of this run.

status

The status of the run, which can be either queued, in_progress, requires_action, cancelling, cancelled, failed, completed, or expired.

requiredAction

Details on the action required to continue the run. Will be null if no action is required.

lastError

The last error associated with this run. Will be null if there are no errors.

expiresAt

The Unix timestamp (in seconds) for when the run will expire.

startedAt

The Unix timestamp (in seconds) for when the run was started.

cancelledAt

The Unix timestamp (in seconds) for when the run was cancelled.

failedAt

The Unix timestamp (in seconds) for when the run failed.

completedAt

The Unix timestamp (in seconds) for when the run was completed.

model

The model that the [assistant](/docs/api-reference/assistants) used for this run.

instructions

The instructions that the [assistant](/docs/api-reference/assistants) used for this run.

tools

The list of tools that the [assistant](/docs/api-reference/assistants) used for this run.

fileIds

The list of [File](/docs/api-reference/files) IDs the [assistant](/docs/api-reference/assistants) used for this run.

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. RunObject
  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 RunObject(id: String, object: Object, createdAt: Int, threadId: String, assistantId: String, status: Status, requiredAction: Optional[RequiredAction], lastError: Optional[LastError], expiresAt: Int, startedAt: Optional[Int], cancelledAt: Optional[Int], failedAt: Optional[Int], completedAt: Optional[Int], model: String, instructions: String, tools: Chunk[ToolsItem], fileIds: Chunk[String], metadata: Optional[Metadata], usage: RunCompletionUsage)

    id

    The identifier, which can be referenced in API endpoints.

    object

    The object type, which is always thread.run.

    createdAt

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

    threadId

    The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run.

    assistantId

    The ID of the [assistant](/docs/api-reference/assistants) used for execution of this run.

    status

    The status of the run, which can be either queued, in_progress, requires_action, cancelling, cancelled, failed, completed, or expired.

    requiredAction

    Details on the action required to continue the run. Will be null if no action is required.

    lastError

    The last error associated with this run. Will be null if there are no errors.

    expiresAt

    The Unix timestamp (in seconds) for when the run will expire.

    startedAt

    The Unix timestamp (in seconds) for when the run was started.

    cancelledAt

    The Unix timestamp (in seconds) for when the run was cancelled.

    failedAt

    The Unix timestamp (in seconds) for when the run failed.

    completedAt

    The Unix timestamp (in seconds) for when the run was completed.

    model

    The model that the [assistant](/docs/api-reference/assistants) used for this run.

    instructions

    The instructions that the [assistant](/docs/api-reference/assistants) used for this run.

    tools

    The list of tools that the [assistant](/docs/api-reference/assistants) used for this run.

    fileIds

    The list of [File](/docs/api-reference/files) IDs the [assistant](/docs/api-reference/assistants) used for this run.

    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: String
  6. val cancelledAt: Optional[Int]
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  8. val completedAt: Optional[Int]
  9. val createdAt: Int
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. val expiresAt: Int
  12. val failedAt: Optional[Int]
  13. val fileIds: Chunk[String]
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  15. val id: String
  16. val instructions: String
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. val lastError: Optional[LastError]
  19. val metadata: Optional[Metadata]
  20. val model: String
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  24. val object: Object
  25. def productElementNames: Iterator[String]
    Definition Classes
    Product
  26. val requiredAction: Optional[RequiredAction]
  27. val startedAt: Optional[Int]
  28. val status: Status
  29. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  30. val threadId: String
  31. val tools: Chunk[ToolsItem]
  32. val usage: RunCompletionUsage
  33. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  34. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  35. 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