core
API
Generated with
core/sttp.openai/sttp.openai.requests/sttp.openai.requests.threads/sttp.openai.requests.threads.runs/ThreadRunsResponseData

ThreadRunsResponseData

sttp.openai.requests.threads.runs.ThreadRunsResponseData
object ThreadRunsResponseData

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Type members

Classlikes

case class CodeInterpreterToolCall(id: String, `type`: String) extends ToolCall

Details of the Code Interpreter tool call the run step was involved in.

Details of the Code Interpreter tool call the run step was involved in.

Value parameters

codeInterpreter

The Code Interpreter tool call definition.

id

The ID of the tool call.

type

The type of tool call. This is always going to be code_interpreter for this type of tool call.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object Error

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
Error.type
trait Error

The last error associated with this run

The last error associated with this run

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class ServerError
case class FunctionCallResult(name: String, arguments: String, output: Option[String])

The definition of the function that was called

The definition of the function that was called

Value parameters

arguments

The arguments passed to the function.

name

The name of the function.

output

The output of the function. This will be null if the outputs have not been submitted yet.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class FunctionToolCall(id: String, `type`: String, function: FunctionCallResult) extends ToolCall

Function tool call

Function tool call

Value parameters

function

The definition of the function that was called.

id

The ID of the tool call object.

type

The type of tool call. This is always going to be function for this type of tool call.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class ListRunStepsResponse(`object`: String, data: Seq[RunStepData], firstId: String, lastId: String, hasMore: Boolean)

Value parameters

data

A list of run objects.

hasMore

}

object

Always "list"

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class ListRunsResponse(`object`: String, data: Seq[RunData], firstId: String, lastId: String, hasMore: Boolean)

Value parameters

data

A list of run objects.

hasMore

}

object

Always "list"

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class MessageCreation(messageId: String) extends StepDetails

Details of the message creation by the run step

Details of the message creation by the run step

Value parameters

messageId

The ID of the message that was created by this run step.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
trait RequiredAction

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

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

https://platform.openai.com/docs/api-reference/runs/object

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
case class RetrievalToolCall(id: String, `type`: String, retrieval: Map[String, String]) extends ToolCall

Retrieval tool call

Retrieval tool call

Value parameters

id

The ID of the tool call object.

retrieval

For now, this is always going to be an empty object.

type

The type of tool call. This is always going to be retrieval for this type of tool call.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class RunData(id: String, `object`: String, createdAt: Int, threadId: String, assistantId: String, status: String, requiredAction: Option[RequiredAction], lastError: Option[Error], expiresAt: Option[Int], startedAt: Option[Int], cancelledAt: Option[Int], failedAt: Option[Int], completedAt: Option[Int], model: String, instructions: Option[String], tools: Seq[Tool], fileIds: Seq[String], metadata: Map[String, String], usage: Option[Usage])

Represents an execution run on a thread

Represents an execution run on a thread

Value parameters

assistantId

The ID of the assistant used for execution of this run.

cancelledAt

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

completedAt

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

createdAt

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

expiresAt

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

failedAt

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

fileIds

The list of File IDs the assistant used for this run.

id

The identifier, which can be referenced in API endpoints.

instructions

The instructions that the assistant used for this run.

lastError

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

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.

model

The model that the assistant used for this run.

object

The object type, which is always thread.run.

requiredAction

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

startedAt

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

status

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

threadId

The ID of the thread that was executed on as a part of this run.

tools

The list of tools that the assistant used for this run.

usage

Usage statistics related to the run. This value will be null if the run is not in a terminal state (i.e. in_progress, queued, etc.). For more information please visit: https://platform.openai.com/docs/api-reference/runs/object

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
RunData.type
case class RunStepData(id: String, `object`: String, createdAt: Int, assistantId: String, threadId: String, runId: String, `type`: String, status: String, stepDetails: StepDetails, lastError: Option[Error], expiredAt: Option[Int], cancelledAt: Option[Int], failedAt: Option[Int], completedAt: Option[Int], metadata: Map[String, String], usage: Option[Usage])

Represents a step in execution of a run

Represents a step in execution of a run

Value parameters

assistantId

The ID of the assistant associated with the run step.

cancelledAt

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

completedAt

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

createdAt

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

expiredAt

The Unix timestamp (in seconds) for when the run step expired. A step is considered expired if the parent run is expired.

failedAt

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

id

The identifier of the run step, which can be referenced in API endpoints.

lastError

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

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.

object

The object type, which is always thread.run.step.

runId

The ID of the run that this run step is a part of.

status

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

stepDetails

The details of the run step.

threadId

The ID of the thread that was run.

type

The type of run step, which can be either message_creation or tool_calls.

usage

Usage statistics related to the run step. This value will be null while the run step's status is in_progress.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object StepDetails

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
trait StepDetails

The details of the run step.

The details of the run step.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class ToolCalls
case class SubmitToolOutputs(toolCalls: Seq[ToolCall])

Value parameters

toolCalls

A list of the relevant tool calls.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class SubmitToolOutputsRequiredAction(`type`: String, submitToolOutputs: SubmitToolOutputs) extends RequiredAction

Value parameters

submitToolOutputs

Details on the tool outputs needed for this run to continue.

type

For now, this is always submit_tool_outputs.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object ToolCall

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
ToolCall.type
trait ToolCall

Details of the tool call

Details of the tool call

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
case class ToolCalls(`type`: String, toolCalls: Seq[ToolCall]) extends StepDetails

Details of the tool call

Details of the tool call

Value parameters

`type`

Always tool_calls.

toolCalls

An array of tool calls the run step was involved in. These can be associated with one of three types of tools: code_interpreter, retrieval, or function.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
ToolCalls.type

Implicits

Implicits

Generated with