api
API
Generated with
api/io.github.quafadas.dairect/RunApi

RunApi

io.github.quafadas.dairect.RunApi
See theRunApi companion trait
object RunApi

Attributes

Companion
trait
Experimental
true
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
RunApi.type

Members list

Type members

Classlikes

case class CreateThread(messages: List[ThreadMessage], tool_resources: Option[ToolResources], metadata: Option[ThreadMetaData])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class RequiredAction(`type`: String, submit_tool_outputs: ToolOutputs)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Run(id: String, `object`: String, created_at: Long, assistant_id: String, thread_id: String, status: RunStatus, required_action: Option[RequiredAction], last_error: Option[RunError], started_at: Option[Long], expires_at: Option[Long], cancelled_at: Option[Long], failed_at: Option[Long], completed_at: Option[Long], incomplete_details: Option[RunIncomplete], model: String, instructions: Option[String], tools: List[AssistantTool], metadata: RunMetaData, usage: Option[Usage], temperature: Double, top_p: Double, max_prompt_tokens: Option[Long], max_completion_tokens: Option[Long], truncation_strategy: TruncationStrategy, tool_choice: ToolChoiceInRun, parallel_tool_calls: Boolean, response_format: ResponseFormat)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class RunError(code: RunErrorType, message: String)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
enum RunErrorType

Attributes

Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class RunIncomplete(reason: String)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class RunList(`object`: String, data: List[Run], first_id: String, last_id: String, has_more: Boolean)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
enum RunStatus

Attributes

Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class RunToolDetail(`type`: String, function: RunToolName)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class RunToolName(name: String)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class StreamRunRequest(assistant_id: String, thread: CreateThread, model: Option[String], instructions: Option[String], additional_instructions: Option[String], tools: Option[List[AssistantTool]], tool_resources: Option[ToolResources], metadata: Option[RunMetaData], temperature: Option[Double], top_p: Option[Double], max_prompt_tokens: Option[Long], max_completion_tokens: Option[Long], truncation_strategy: Option[TruncationStrategy], tool_choice: Option[ToolChoiceInRun], parallel_tool_calls: Option[Boolean], response_format: Option[ResponseFormat], stream: Boolean)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class StreamThreadRunRequest(assistant_id: String, model: Option[String], instructions: Option[String], additional_instructions: Option[String], tools: Option[List[AssistantTool]], tool_resources: Option[ToolResources], metadata: Option[RunMetaData], temperature: Option[Double], top_p: Option[Double], max_prompt_tokens: Option[Long], max_completion_tokens: Option[Long], truncation_strategy: Option[TruncationStrategy], tool_choice: Option[ToolChoiceInRun], parallel_tool_calls: Option[Boolean], response_format: Option[ResponseFormat], stream: Boolean)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class StreamToolOutput(tool_outputs: List[ToolOutput], stream: Boolean)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
enum ToolChoiceInRun

Attributes

Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ToolOutput(tool_call_id: String, output: String)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ToolOutputs(tool_calls: List[ToolCall])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
enum ToolTreatment

Attributes

Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ToolTreatmentW(tt: ToolTreatment)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class TruncationStrategy(`type`: String, last_messages: Option[String])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Usage(prompt_tokens: Int, completion_tokens: Int, total_tokens: Int)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Value members

Concrete methods

def apply(client: Client[IO], baseUrl: Uri): Resource[IO, RunApi]

Givens

Givens

given derived$API: API[RunApi]
Generated with