Packages

class Live extends FineTuning

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Live
  2. FineTuning
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Live(client: Client, baseURL: URL, apiKey: Secret, boundary: Boundary)

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 cancelFineTuningJob(fine_tuning_job_id: String): ZIO[Any, OpenAIFailure, FineTuningJob]

    Immediately cancel a fine-tune job.

    Immediately cancel a fine-tune job.

    fine_tuning_job_id

    The ID of the fine-tuning job to cancel.

    Definition Classes
    LiveFineTuning
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. def createFineTuningJob(body: CreateFineTuningJobRequest): ZIO[Any, OpenAIFailure, FineTuningJob]

    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.

    Response includes details of the enqueued job including job status and the name of the fine-tuned models once complete.

    [Learn more about fine-tuning](/docs/guides/fine-tuning)

    Definition Classes
    LiveFineTuning
  8. def createFineTuningJob(model: Model, trainingFile: String, hyperparameters: Optional[Hyperparameters] = Optional.Absent, suffix: Optional[Suffix] = Optional.Absent, validationFile: Optional[String] = Optional.Absent): ZIO[Any, OpenAIFailure, FineTuningJob]

    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.

    Response includes details of the enqueued job including job status and the name of the fine-tuned models once complete.

    [Learn more about fine-tuning](/docs/guides/fine-tuning)

    model

    The name of the model to fine-tune. You can select one of the [supported models](/docs/guides/fine-tuning/what-models-can-be-fine-tuned).

    trainingFile

    The ID of an uploaded file that contains training data. See [upload file](/docs/api-reference/files/upload) for how to upload a file. Your dataset must be formatted as a JSONL file. Additionally, you must upload your file with the purpose fine-tune. See the [fine-tuning guide](/docs/guides/fine-tuning) for more details.

    hyperparameters

    The hyperparameters used for the fine-tuning job.

    suffix

    A string of up to 18 characters that will be added to your fine-tuned model name. For example, a suffix of "custom-model-name" would produce a model name like ft:gpt-3.5-turbo:openai:custom-model-name:7p4lURel.

    validationFile

    The ID of an uploaded file that contains validation data. If you provide this file, the data is used to generate validation metrics periodically during fine-tuning. These metrics can be viewed in the fine-tuning results file. The same data should not be present in both train and validation files. Your dataset must be formatted as a JSONL file. You must upload your file with the purpose fine-tune. See the [fine-tuning guide](/docs/guides/fine-tuning) for more details.

    Definition Classes
    FineTuning
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. def listFineTuningEvents(fine_tuning_job_id: String, after: Optional[String], limit: Optional[Int]): ZIO[Any, OpenAIFailure, ListFineTuningJobEventsResponse]

    Get status updates for a fine-tuning job.

    Get status updates for a fine-tuning job.

    fine_tuning_job_id

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

    after

    Identifier for the last event from the previous pagination request.

    limit

    Number of events to retrieve.

    Definition Classes
    LiveFineTuning
  16. def listPaginatedFineTuningJobs(after: Optional[String], limit: Optional[Int]): ZIO[Any, OpenAIFailure, ListPaginatedFineTuningJobsResponse]

    List your organization's fine-tuning jobs

    List your organization's fine-tuning jobs

    after

    Identifier for the last job from the previous pagination request.

    limit

    Number of fine-tuning jobs to retrieve.

    Definition Classes
    LiveFineTuning
  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 retrieveFineTuningJob(fine_tuning_job_id: String): ZIO[Any, OpenAIFailure, FineTuningJob]

    Get info about a fine-tuning job.

    Get info about a fine-tuning job.

    [Learn more about fine-tuning](/docs/guides/fine-tuning)

    fine_tuning_job_id

    The ID of the fine-tuning job.

    Definition Classes
    LiveFineTuning
  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()

Inherited from FineTuning

Inherited from AnyRef

Inherited from Any

Ungrouped