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 createFile(body: CreateFileRequest): ZIO[Any, OpenAIFailure, OpenAIFile]

   Upload a file that can be used across various endpoints/features.

   Upload a file that can be used across various endpoints/features. The size of all the files uploaded by one organization can be up to 100 GB.

   The size of individual files for can be a maximum of 512MB. See the [Assistants Tools guide](/docs/assistants/tools) to learn more about the types of files supported. The Fine-tuning API only supports .jsonl files.

   Please [contact us](https://help.openai.com/) if you need to increase these storage limits.

   Definition Classes

   Live → Files

7.  def createFile(file: File, purpose: Purpose): ZIO[Any, OpenAIFailure, OpenAIFile]

   Upload a file that can be used across various endpoints/features.

   Upload a file that can be used across various endpoints/features. The size of all the files uploaded by one organization can be up to 100 GB.

   The size of individual files for can be a maximum of 512MB. See the [Assistants Tools guide](/docs/assistants/tools) to learn more about the types of files supported. The Fine-tuning API only supports .jsonl files.

   Please [contact us](https://help.openai.com/) if you need to increase these storage limits.

   file

   The File object (not file name) to be uploaded.

   purpose

   The intended purpose of the uploaded file. Use "fine-tune" for [Fine-tuning](/docs/api-reference/fine-tuning) and "assistants" for [Assistants](/docs/api-reference/assistants) and [Messages](/docs/api-reference/messages). This allows us to validate the format of the uploaded file is correct for fine-tuning.

   Definition Classes

   Files

8.  def deleteFile(file_id: String): ZIO[Any, OpenAIFailure, DeleteFileResponse]

   Delete a file.

   Delete a file.

   file_id

   The ID of the file to use for this request.

   Definition Classes

   Live → Files

9.  def downloadFile(file_id: String): ZIO[Any, OpenAIFailure, String]

   Returns the contents of the specified file.

   Returns the contents of the specified file.

   file_id

   The ID of the file to use for this request.

   Definition Classes

   Live → Files

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

    Definition Classes

    AnyRef

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

    Definition Classes

    AnyRef → Any

12.  def finalize(): Unit

    Attributes

    protected[lang]

    Definition Classes

    AnyRef

    Annotations

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

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

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

14.  def hashCode(): Int

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

15.  final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

16.  def listFiles(purpose: Optional[String] = Optional.Absent): ZIO[Any, OpenAIFailure, ListFilesResponse]

    Returns a list of files that belong to the user's organization.

    Returns a list of files that belong to the user's organization.

    purpose

    Only return files with the given purpose.

    Definition Classes

    Live → Files

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

    Definition Classes

    AnyRef

18.  final def notify(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

19.  final def notifyAll(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

20.  def retrieveFile(file_id: String): ZIO[Any, OpenAIFailure, OpenAIFile]

    Returns information about a specific file.

    Returns information about a specific file.

    file_id

    The ID of the file to use for this request.

    Definition Classes

    Live → Files

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

    Definition Classes

    AnyRef

22.  def toString(): String

    Definition Classes

    AnyRef → Any

23.  final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

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

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

    Definition Classes

    AnyRef

    Annotations

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

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

    Definition Classes

    AnyRef

    Annotations

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