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

ThreadRunsRequestBody

sttp.openai.requests.threads.runs.ThreadRunsRequestBody
object ThreadRunsRequestBody

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Type members

Classlikes

case class CreateRun(assistantId: String, model: Option[String], instructions: Option[String], additionalInstructions: Option[String], tools: Seq[Tool], metadata: Map[String, String])

Value parameters

additionalInstructions

Appends additional instructions at the end of the instructions for the run. This is useful for modifying the behavior on a per-run basis without overriding other instructions.

assistantId

The ID of the assistant to use to execute this run.

instructions

Overrides the instructions of the assistant. This is useful for modifying the behavior on a per-run basis.

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/runs/createRun

model

The ID of the Model to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used.

tools

Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
CreateRun.type
case class CreateThreadAndRun(assistantId: String, thread: CreateThreadBody, model: Option[String], instructions: Option[String], tools: Seq[Tool], toolResources: Option[ToolResources], metadata: Map[String, String])

Value parameters

assistantId

The ID of the assistant to use to execute this run.

instructions

Overrides the instructions of the assistant. This is useful for modifying the behavior on a per-run basis.

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/runs/createThreadAndRun

model

The ID of the Model to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used.

tools

Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class ModifyRun(metadata: Map[String, String])

Value parameters

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/runs/modifyRun

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
ModifyRun.type
case class SubmitToolOutputsToRun(toolOutputs: Seq[ToolOutput])

Value parameters

toolOutputs

A list of tools for which the outputs are being submitted. For more information please visit: https://platform.openai.com/docs/api-reference/runs/submitToolOutputs

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class ToolOutput(toolCallId: Option[String], output: String)

Value parameters

output

The output of the tool call to be submitted to continue the run.

toolCallId

The ID of the tool call in the required_action object within the run object the output is being submitted for.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
ToolOutput.type
Generated with