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

RunApi

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

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

Attributes

Companion
object
Experimental
true
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Abstract methods

def cancel(thread_id: String, run_id: String): IO[Run]
def create(thread_id: String, assistant_id: String, model: Option[String], instructions: Option[String], additional_instructions: Option[String], additional_messages: Option[List[ThreadMessage]], tools: Option[List[AssistantTool]], metadata: 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: ResponseFormat): IO[Run]
def createThreadAndRun(assistant_id: String, thread: CreateThread, model: Option[String], 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]): IO[Run]
def get(thread_id: String, run_id: String): IO[Run]
def list(thread_id: String, run_id: String, limit: Option[Int], order: Option[String], after: Option[String], before: Option[String]): IO[RunList]
def modify(thread_id: String, run_id: String, metadata: RunMetaData): IO[Run]
def submitToolOutput(thread_id: String, run_id: String, tool_outputs: List[ToolOutput]): IO[Run]

Experimental methods

def createThreadRunStream(authdClient: Client[IO], 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], baseUrl: String): Stream[IO, AssistantStreamEvent]
Extension method from io.github.quafadas.dairect

Attributes

Experimental
true
def streamRun(authdClient: Client[IO], thread_id: String, assistant_id: String, model: Option[String], instructions: Option[String], additional_instructions: Option[String], additional_messages: Option[List[ThreadMessage]], tools: Option[List[AssistantTool]], 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], baseUrl: String): Stream[IO, AssistantStreamEvent]
Extension method from io.github.quafadas.dairect

Attributes

Experimental
true
def streamToolOutput(authdClient: Client[IO], thread_id: String, run_id: String, tool_outputs: List[ToolOutput], baseUrl: String): Stream[IO, AssistantStreamEvent]
Extension method from io.github.quafadas.dairect

Attributes

Experimental
true
Generated with