trait Files extends AnyRef
- Alphabetic
- By Inheritance
- Files
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def createFile(body: CreateFileRequest): ZIO[Any, OpenAIFailure, OpenAIFile]
Upload a file that contains document(s) to be used across various endpoints/features.
Upload a file that contains document(s) to be used across various endpoints/features. Currently, the size of all the files uploaded by one organization can be up to 1 GB. Please contact us if you need to increase the storage limit.
- 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
- 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
- abstract def listFiles(): ZIO[Any, OpenAIFailure, ListFilesResponse]
Returns a list of files that belong to the user's organization.
- 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
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def createFile(file: File, purpose: String): ZIO[Any, OpenAIFailure, OpenAIFile]
Upload a file that contains document(s) to be used across various endpoints/features.
Upload a file that contains document(s) to be used across various endpoints/features. Currently, the size of all the files uploaded by one organization can be up to 1 GB. Please contact us if you need to increase the storage limit.
- file
Name of the [JSON Lines](https://jsonlines.readthedocs.io/en/latest/) file to be uploaded. If the
purposeis set to "fine-tune", each line is a JSON record with "prompt" and "completion" fields representing your [training examples](/docs/guides/fine-tuning/prepare-training-data).- purpose
The intended purpose of the uploaded documents. Use "fine-tune" for [Fine-tuning](/docs/api-reference/fine-tunes). This allows us to validate the format of the uploaded file.
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()