final case class CreateRunRequest(assistantId: String, model: Optional[String] = Optional.Absent, instructions: Optional[String] = Optional.Absent, additionalInstructions: Optional[String] = Optional.Absent, tools: Optional[Chunk[ToolsItem]] = Optional.Absent, metadata: Optional[Metadata] = Optional.Absent) extends Product with Serializable
CreateRunRequest model
- assistantId
The ID of the [assistant](/docs/api-reference/assistants) to use to execute this run.
- model
The ID of the [Model](/docs/api-reference/models) 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.
- instructions
Overrides the [instructions](/docs/api-reference/assistants/createAssistant) of the assistant. This is useful for modifying the behavior on a per-run basis.
- 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.
- tools
Override the tools the assistant can use for this run. 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.
- Alphabetic
- By Inheritance
- CreateRunRequest
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new CreateRunRequest(assistantId: String, model: Optional[String] = Optional.Absent, instructions: Optional[String] = Optional.Absent, additionalInstructions: Optional[String] = Optional.Absent, tools: Optional[Chunk[ToolsItem]] = Optional.Absent, metadata: Optional[Metadata] = Optional.Absent)
- assistantId
The ID of the [assistant](/docs/api-reference/assistants) to use to execute this run.
- model
The ID of the [Model](/docs/api-reference/models) 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.
- instructions
Overrides the [instructions](/docs/api-reference/assistants/createAssistant) of the assistant. This is useful for modifying the behavior on a per-run basis.
- 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.
- tools
Override the tools the assistant can use for this run. 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.
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
- val additionalInstructions: Optional[String]
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val assistantId: String
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- val instructions: Optional[String]
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val metadata: Optional[Metadata]
- val model: Optional[String]
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val tools: Optional[Chunk[ToolsItem]]
- 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()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])