Packages

trait Files extends AnyRef

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

Abstract Value Members

  1. abstract def createFile(body: CreateFileRequest): ZIO[Any, OpenAIFailure, OpenAIFile]

    Upload a file that can be used across various endpoints.

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

    The size of individual files can be a maximum of 512 MB or 2 million tokens for Assistants. 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.

  2. abstract 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.

  3. abstract 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.

  4. abstract 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.

  5. abstract 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.

Concrete 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]) @IntrinsicCandidate() @native()
  6. def createFile(file: File, purpose: Purpose): ZIO[Any, OpenAIFailure, OpenAIFile]

    Upload a file that can be used across various endpoints.

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

    The size of individual files can be a maximum of 512 MB or 2 million tokens for Assistants. 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.

  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  19. 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