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 clone(): AnyRef

   Attributes

   protected[lang]

   Definition Classes

   AnyRef

   Annotations

   @throws(classOf[java.lang.CloneNotSupportedException]) @native()

6.  def createAssistant(model: Model, name: Optional[Name] = Optional.Absent, description: Optional[Description] = Optional.Absent, instructions: Optional[Instructions] = Optional.Absent, tools: Optional[Chunk[ToolsItem]] = Optional.Absent, fileIds: Optional[Chunk[String]] = Optional.Absent, metadata: Optional[Metadata] = Optional.Absent): ZIO[Assistants, OpenAIFailure, AssistantObject]

   Create an assistant with a model and instructions.

   Create an assistant with a model and instructions.

   model

   ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models/overview) for descriptions of them.

   name

   The name of the assistant. The maximum length is 256 characters.

   description

   The description of the assistant. The maximum length is 512 characters.

   instructions

   The system instructions that the assistant uses. The maximum length is 32768 characters.

   tools

   A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types code_interpreter, retrieval, or function.

   fileIds

   A list of [file](/docs/api-reference/files) IDs attached to this assistant. There can be a maximum of 20 files attached to the assistant. Files are ordered by their creation date in ascending order.

   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.

7.  def createAssistant(body: CreateAssistantRequest): ZIO[Assistants, OpenAIFailure, AssistantObject]

   Create an assistant with a model and instructions.

8.  def createAssistantFile(assistant_id: String, body: CreateAssistantFileRequest): ZIO[Assistants, OpenAIFailure, AssistantFileObject]

   Create an assistant file by attaching a [File](/docs/api-reference/files) to an [assistant](/docs/api-reference/assistants).

9.  def default: ZLayer[Any, Throwable, Assistants]
10.  def deleteAssistant(assistant_id: String): ZIO[Assistants, OpenAIFailure, DeleteAssistantResponse]

    Delete an assistant.

11.  def deleteAssistantFile(assistant_id: String, file_id: String): ZIO[Assistants, OpenAIFailure, DeleteAssistantFileResponse]

    Delete an assistant file.

12.  final def eq(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

13.  def equals(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef → Any

14.  def finalize(): Unit

    Attributes

    protected[lang]

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.Throwable])

15.  def getAssistant(assistant_id: String): ZIO[Assistants, OpenAIFailure, AssistantObject]

    Retrieves an assistant.

16.  def getAssistantFile(assistant_id: String, file_id: String): ZIO[Assistants, OpenAIFailure, AssistantFileObject]

    Retrieves an AssistantFile.

17.  final def getClass(): Class[_ <: AnyRef]

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

18.  def hashCode(): Int

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

19.  final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

20.  def listAssistantFiles(assistant_id: String, limit: Optional[Int] = Optional.Absent, order: Optional[AssistantsListAssistantFilesOrder] = Optional.Absent, after: Optional[String] = Optional.Absent, before: Optional[String] = Optional.Absent): ZIO[Assistants, OpenAIFailure, ListAssistantFilesResponse]

    Returns a list of assistant files.

21.  def listAssistants(limit: Optional[Int] = Optional.Absent, order: Optional[AssistantsListAssistantsOrder] = Optional.Absent, after: Optional[String] = Optional.Absent, before: Optional[String] = Optional.Absent): ZIO[Assistants, OpenAIFailure, ListAssistantsResponse]

    Returns a list of assistants.

22.  def live: ZLayer[Client, Nothing, Assistants]
23.  def modifyAssistant(assistant_id: String, body: ModifyAssistantRequest): ZIO[Assistants, OpenAIFailure, AssistantObject]

    Modifies an assistant.

24.  final def ne(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

25.  final def notify(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

26.  final def notifyAll(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

27.  final def synchronized[T0](arg0: => T0): T0

    Definition Classes

    AnyRef

28.  def toString(): String

    Definition Classes

    AnyRef → Any

29.  final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.InterruptedException])

30.  final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.InterruptedException])

31.  final def wait(arg0: Long): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.InterruptedException]) @native()