Packages

object Threads

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Threads
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. class Live extends Threads

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def cancelRun(thread_id: String, run_id: String): ZIO[Threads, OpenAIFailure, RunObject]

    Cancels a run that is in_progress.

  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  7. def createMessage(thread_id: String, body: CreateMessageRequest): ZIO[Threads, OpenAIFailure, MessageObject]

    Create a message.

  8. def createRun(thread_id: String, body: CreateRunRequest): ZIO[Threads, OpenAIFailure, RunObject]

    Create a run.

  9. def createThread(messages: Optional[Chunk[CreateMessageRequest]] = Optional.Absent, metadata: Optional[Metadata] = Optional.Absent): ZIO[Threads, OpenAIFailure, ThreadObject]

    Create a thread.

    Create a thread.

    messages

    A list of [messages](/docs/api-reference/messages) to start the thread with.

    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.

  10. def createThread(body: CreateThreadRequest): ZIO[Threads, OpenAIFailure, ThreadObject]

    Create a thread.

  11. def createThreadAndRun(assistantId: String, thread: Optional[CreateThreadRequest] = Optional.Absent, model: Optional[String] = Optional.Absent, instructions: Optional[String] = Optional.Absent, tools: Optional[Chunk[ToolsItem]] = Optional.Absent, metadata: Optional[Metadata] = Optional.Absent): ZIO[Threads, OpenAIFailure, RunObject]

    Create a thread and run it in one request.

    Create a thread and run it in one request.

    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

    Override the default system message of the assistant. This is useful for modifying the behavior on a per-run basis.

    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.

  12. def createThreadAndRun(body: CreateThreadAndRunRequest): ZIO[Threads, OpenAIFailure, RunObject]

    Create a thread and run it in one request.

  13. def default: ZLayer[Any, Throwable, Threads]
  14. def deleteThread(thread_id: String): ZIO[Threads, OpenAIFailure, DeleteThreadResponse]

    Delete a thread.

  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  18. def getMessage(thread_id: String, message_id: String): ZIO[Threads, OpenAIFailure, MessageObject]

    Retrieve a message.

  19. def getMessageFile(thread_id: String, message_id: String, file_id: String): ZIO[Threads, OpenAIFailure, MessageFileObject]

    Retrieves a message file.

  20. def getRun(thread_id: String, run_id: String): ZIO[Threads, OpenAIFailure, RunObject]

    Retrieves a run.

  21. def getRunStep(thread_id: String, run_id: String, step_id: String): ZIO[Threads, OpenAIFailure, RunStepObject]

    Retrieves a run step.

  22. def getThread(thread_id: String): ZIO[Threads, OpenAIFailure, ThreadObject]

    Retrieves a thread.

  23. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. def listMessageFiles(thread_id: String, message_id: String, limit: Optional[Int] = Optional.Absent, order: Optional[ThreadsListMessageFilesOrder] = Optional.Absent, after: Optional[String] = Optional.Absent, before: Optional[String] = Optional.Absent): ZIO[Threads, OpenAIFailure, ListMessageFilesResponse]

    Returns a list of message files.

  26. def listMessages(thread_id: String, limit: Optional[Int] = Optional.Absent, order: Optional[ThreadsListMessagesOrder] = Optional.Absent, after: Optional[String] = Optional.Absent, before: Optional[String] = Optional.Absent): ZIO[Threads, OpenAIFailure, ListMessagesResponse]

    Returns a list of messages for a given thread.

  27. def listRunSteps(thread_id: String, run_id: String, limit: Optional[Int] = Optional.Absent, order: Optional[ThreadsListRunStepsOrder] = Optional.Absent, after: Optional[String] = Optional.Absent, before: Optional[String] = Optional.Absent): ZIO[Threads, OpenAIFailure, ListRunStepsResponse]

    Returns a list of run steps belonging to a run.

  28. def listRuns(thread_id: String, limit: Optional[Int] = Optional.Absent, order: Optional[ThreadsListRunsOrder] = Optional.Absent, after: Optional[String] = Optional.Absent, before: Optional[String] = Optional.Absent): ZIO[Threads, OpenAIFailure, ListRunsResponse]

    Returns a list of runs belonging to a thread.

  29. def live: ZLayer[Client, Nothing, Threads]
  30. def modifyMessage(thread_id: String, message_id: String, body: ModifyMessageRequest): ZIO[Threads, OpenAIFailure, MessageObject]

    Modifies a message.

  31. def modifyRun(thread_id: String, run_id: String, body: ModifyRunRequest): ZIO[Threads, OpenAIFailure, RunObject]

    Modifies a run.

  32. def modifyThread(thread_id: String, body: ModifyThreadRequest): ZIO[Threads, OpenAIFailure, ThreadObject]

    Modifies a thread.

  33. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  34. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  35. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  36. def submitToolOuputsToRun(thread_id: String, run_id: String, body: SubmitToolOutputsRunRequest): ZIO[Threads, OpenAIFailure, RunObject]

    When a run has the status: "requires_action" and required_action.type is submit_tool_outputs, this endpoint can be used to submit the outputs from the tool calls once they're all completed.

    When a run has the status: "requires_action" and required_action.type is submit_tool_outputs, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request.

  37. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  38. def toString(): String
    Definition Classes
    AnyRef → Any
  39. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  40. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  41. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped