Packages

class OpenAI extends AnyRef

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

Instance Constructors

  1. new OpenAI(authToken: String)

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 cancelFineTune(fineTuneId: String): Request[Either[OpenAIException, FineTuneResponse]]

    Immediately cancel a fine-tune job.

    Immediately cancel a fine-tune job.

    https://platform.openai.com/docs/api-reference/fine-tunes/cancel

    fineTuneId

    The ID of the fine-tune job to cancel.

  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  7. def createChatCompletion(chatBody: ChatBody): Request[Either[OpenAIException, ChatResponse]]

    Creates a model response for the given chat conversation defined in chatBody.

    Creates a model response for the given chat conversation defined in chatBody.

    https://platform.openai.com/docs/api-reference/chat/create

    chatBody

    Chat request body.

  8. def createCompletion(completionBody: CompletionsBody): Request[Either[OpenAIException, CompletionsResponse]]

    Creates a completion for the provided prompt and parameters given in request body.

    Creates a completion for the provided prompt and parameters given in request body.

    https://platform.openai.com/docs/api-reference/completions/create

    completionBody

    Create completion request body.

  9. def createEdit(editRequestBody: EditBody): Request[Either[OpenAIException, EditResponse]]

    Creates a new edit for provided request body.

    Creates a new edit for provided request body.

    https://platform.openai.com/docs/api-reference/edits/create

    editRequestBody

    Edit request body.

  10. def createEmbeddings(embeddingsBody: EmbeddingsBody): Request[Either[OpenAIException, EmbeddingResponse]]

    Gets info about the fine-tune job.

    Gets info about the fine-tune job.

    https://platform.openai.com/docs/api-reference/embeddings/create

    embeddingsBody

    Embeddings request body.

  11. def createFineTune(fineTunesRequestBody: FineTunesRequestBody): Request[Either[OpenAIException, FineTuneResponse]]

    Creates a job that fine-tunes a specified model from a given dataset.

    Creates a job that fine-tunes a specified model from a given dataset.

    https://platform.openai.com/docs/api-reference/fine-tunes/create

    fineTunesRequestBody

    Request body that will be used to create a fine-tune.

  12. def createImage(imageCreationBody: ImageCreationBody): Request[Either[OpenAIException, ImageResponse]]

    Creates an image given a prompt in request body.

    Creates an image given a prompt in request body.

    https://platform.openai.com/docs/api-reference/images/create

    imageCreationBody

    Create image request body.

  13. def createModeration(moderationsBody: ModerationsBody): Request[Either[OpenAIException, ModerationData]]

    Classifies if text violates OpenAI's Content Policy.

    Classifies if text violates OpenAI's Content Policy.

    https://platform.openai.com/docs/api-reference/moderations/create

    moderationsBody

    Moderation request body.

  14. def createTranscription(transcriptionConfig: TranscriptionConfig): Request[Either[OpenAIException, AudioResponse]]

    Transcribes audio into the input language.

    Transcribes audio into the input language.

    transcriptionConfig

    An instance of the case class TranscriptionConfig containing the necessary parameters for the audio transcription

    returns

    An url to edited image.

  15. def createTranscription(systemPath: String, model: RecognitionModel): Request[Either[OpenAIException, AudioResponse]]

    Transcribes audio into the input language.

    Transcribes audio into the input language.

    https://platform.openai.com/docs/api-reference/audio/create

    systemPath

    The audio systemPath to transcribe, in one of these formats: mp3, mp4, mpeg, mpga, m4a, wav, or webm.

    model

    ID of the model to use. Only whisper-1 is currently available.

  16. def createTranscription(file: File, model: RecognitionModel): Request[Either[OpenAIException, AudioResponse]]

    Transcribes audio into the input language.

    Transcribes audio into the input language.

    https://platform.openai.com/docs/api-reference/audio/create

    file

    The audio file to transcribe, in one of these formats: mp3, mp4, mpeg, mpga, m4a, wav, or webm.

    model

    ID of the model to use. Only whisper-1 is currently available.

  17. def createTranslation(translationConfig: TranslationConfig): Request[Either[OpenAIException, AudioResponse]]

    Translates audio into English text.

    Translates audio into English text.

    https://platform.openai.com/docs/api-reference/audio/create

    translationConfig

    An instance of the case class TranslationConfig containing the necessary parameters for the audio translation.

  18. def createTranslation(systemPath: String, model: RecognitionModel): Request[Either[OpenAIException, AudioResponse]]

    Translates audio into English text.

    Translates audio into English text.

    https://platform.openai.com/docs/api-reference/audio/create

    systemPath

    The audio systemPath to transcribe, in one of these formats: mp3, mp4, mpeg, mpga, m4a, wav, or webm.

    model

    ID of the model to use. Only whisper-1 is currently available.

  19. def createTranslation(file: File, model: RecognitionModel): Request[Either[OpenAIException, AudioResponse]]

    Translates audio into English text.

    Translates audio into English text.

    https://platform.openai.com/docs/api-reference/audio/create

    file

    The audio file to translate, in one of these formats: mp3, mp4, mpeg, mpga, m4a, wav, or webm.

    model

    ID of the model to use. Only whisper-1 is currently available.

  20. def deleteFile(fileId: String): Request[Either[OpenAIException, DeletedFileData]]

    Delete a file.

    Delete a file.

    https://platform.openai.com/docs/api-reference/files/delete

    fileId

    The ID of the file to use for this request.

  21. def deleteFineTuneModel(model: String): Request[Either[OpenAIException, DeleteFineTuneModelResponse]]

    Delete a fine-tuned model.

    Delete a fine-tuned model. You must have the Owner role in your organization.

    https://platform.openai.com/docs/api-reference/fine-tunes/delete-model

    model

    The model to delete.

  22. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  24. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. def getFiles: Request[Either[OpenAIException, FilesResponse]]

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

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

    https://platform.openai.com/docs/api-reference/files

  26. def getFineTuneEvents(fineTuneId: String): Request[Either[OpenAIException, FineTuneEventsResponse]]

    Get fine-grained status updates for a fine-tune job.

    Get fine-grained status updates for a fine-tune job.

    https://platform.openai.com/docs/api-reference/fine-tunes/events

    fineTuneId

    The ID of the fine-tune job to get events for.

  27. def getFineTunes: Request[Either[OpenAIException, GetFineTunesResponse]]

    List of your organization's fine-tuning jobs.

    List of your organization's fine-tuning jobs.

    https://platform.openai.com/docs/api-reference/fine-tunes/list

  28. def getModels: Request[Either[OpenAIException, ModelsResponse]]

    Lists the currently available models, and provides basic information about each one such as the owner and availability.

    Lists the currently available models, and provides basic information about each one such as the owner and availability.

    https://platform.openai.com/docs/api-reference/models

  29. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  30. def imageEdits(imageEditsConfig: ImageEditsConfig): Request[Either[OpenAIException, ImageResponse]]

    Creates edited or extended images given an original image and a prompt.

    Creates edited or extended images given an original image and a prompt.

    https://platform.openai.com/docs/api-reference/images/create-edit

    imageEditsConfig

    An instance of the case class ImageEditConfig containing the necessary parameters for editing the image.

  31. def imageEdits(systemPath: String, prompt: String): Request[Either[OpenAIException, ImageResponse]]

    Creates edited or extended images given an original image and a prompt.

    Creates edited or extended images given an original image and a prompt.

    https://platform.openai.com/docs/api-reference/images/create-edit

    systemPath

    Path to the image to be edited. Must be a valid PNG file, less than 4MB, and square. If mask is not provided, image must have transparency, which will be used as the mask

    prompt

    A text description of the desired image. The maximum length is 1000 characters.

  32. def imageEdits(image: File, prompt: String): Request[Either[OpenAIException, ImageResponse]]

    Creates edited or extended images given an original image and a prompt.

    Creates edited or extended images given an original image and a prompt.

    https://platform.openai.com/docs/api-reference/images/create-edit

    image

    The image to be edited. Must be a valid PNG file, less than 4MB, and square. If mask is not provided, image must have transparency, which will be used as the mask.

    prompt

    A text description of the desired image. The maximum length is 1000 characters.

  33. def imageVariations(imageVariationsConfig: ImageVariationsConfig): Request[Either[OpenAIException, ImageResponse]]

    Creates a variation of a given image.

    Creates a variation of a given image.

    https://platform.openai.com/docs/api-reference/images/create-variation

    imageVariationsConfig

    An instance of the case class ImageVariationsConfig containing the necessary parameters for the image variation.

  34. def imageVariations(systemPath: String): Request[Either[OpenAIException, ImageResponse]]

    Creates a variation of a given image.

    Creates a variation of a given image.

    https://platform.openai.com/docs/api-reference/images/create-variation

    systemPath

    Path to the image to use as the basis for the variation. Must be a valid PNG file, less than 4MB, and square.

  35. def imageVariations(image: File): Request[Either[OpenAIException, ImageResponse]]

    Creates a variation of a given image.

    Creates a variation of a given image.

    https://platform.openai.com/docs/api-reference/images/create-variation

    image

    The image to use as the basis for the variation. Must be a valid PNG file, less than 4MB, and square.

  36. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  37. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  38. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  39. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  40. def retrieveFile(fileId: String): Request[Either[OpenAIException, FileData]]

    Returns information about a specific file.

    Returns information about a specific file.

    https://platform.openai.com/docs/api-reference/files/retrieve

    fileId

    The ID of the file to use for this request.

  41. def retrieveFileContent(fileId: String): Request[Either[OpenAIException, String]]

    Returns the contents of the specified file.

    Returns the contents of the specified file.

    https://platform.openai.com/docs/api-reference/files/retrieve-content

    fileId

    The ID of the file.

  42. def retrieveFineTune(fineTuneId: String): Request[Either[OpenAIException, FineTuneResponse]]

    Gets info about the fine-tune job.

    Gets info about the fine-tune job.

    https://platform.openai.com/docs/api-reference/fine-tunes/retrieve

    fineTuneId

    The ID of the fine-tune job.

  43. def retrieveModel(modelId: String): Request[Either[OpenAIException, ModelData]]

    Retrieves a model instance, providing basic information about the model such as the owner and permissions.

    Retrieves a model instance, providing basic information about the model such as the owner and permissions.

    https://platform.openai.com/docs/api-reference/models/retrieve

    modelId

    The ID of the model to use for this request.

  44. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  45. def toString(): String
    Definition Classes
    AnyRef → Any
  46. def uploadFile(systemPath: String): Request[Either[OpenAIException, FileData]]

    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 OpenAI if you need to increase the storage limit.

    https://platform.openai.com/docs/api-reference/files/upload

    systemPath

    Path to the JSON Lines file to be uploaded and the purpose is set to "fine-tune", each line is a JSON record with "prompt" and "completion" fields representing your training examples.

  47. def uploadFile(systemPath: String, purpose: String): Request[Either[OpenAIException, FileData]]

    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 OpenAI if you need to increase the storage limit.

    https://platform.openai.com/docs/api-reference/files/upload

    systemPath

    Path to the JSON Lines file to be uploaded. If the purpose is set to "fine-tune", each line is a JSON record with "prompt" and "completion" fields representing your training examples.

    purpose

    The intended purpose of the uploaded documents. Use "fine-tune" for Fine-tuning. This allows OpenAI to validate the format of the uploaded file.

  48. def uploadFile(file: File): Request[Either[OpenAIException, FileData]]

    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 OpenAI if you need to increase the storage limit.

    https://platform.openai.com/docs/api-reference/files/upload

    file

    JSON Lines file to be uploaded and the purpose is set to "fine-tune", each line is a JSON record with "prompt" and "completion" fields representing your training examples.

  49. def uploadFile(file: File, purpose: String): Request[Either[OpenAIException, FileData]]

    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 OpenAI if you need to increase the storage limit.

    https://platform.openai.com/docs/api-reference/files/upload

    file

    JSON Lines file to be uploaded. If the purpose is set to "fine-tune", each line is a JSON record with "prompt" and "completion" fields representing your training examples.

    purpose

    The intended purpose of the uploaded documents. Use "fine-tune" for Fine-tuning. This allows OpenAI to validate the format of the uploaded file.

  50. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  51. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  52. 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

Inherited from AnyRef

Inherited from Any

Ungrouped