commonMain.com.aallam.openai.client.FineTunes.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of openai-client Show documentation

OpenAI API Kotlin Client

There is a newer version: 4.0.0-beta01

package com.aallam.openai.client

import com.aallam.openai.api.finetune.FineTune
import com.aallam.openai.api.finetune.FineTuneEvent
import com.aallam.openai.api.finetune.FineTuneId
import com.aallam.openai.api.finetune.FineTuneRequest
import com.aallam.openai.api.model.ModelId
import kotlinx.coroutines.flow.Flow

/**
 * Manage fine-tuning jobs to tailor a model to your specific training data.
 */
public interface FineTunes {

    /**
     * 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.
     */
    @Deprecated("Use FineTuning instead.")
    public suspend fun fineTune(request: FineTuneRequest): FineTune

    /**
     * List your organization's fine-tuning jobs.
     */
    @Deprecated("Use FineTuning instead.")
    public suspend fun fineTunes(): List

    /**
     * Gets info about to fine-tune job.
     */
    @Deprecated("Use FineTuning instead.")
    public suspend fun fineTune(fineTuneId: FineTuneId): FineTune?

    /**
     * Immediately cancel a fine-tune job.
     */
    @Deprecated("Use FineTuning instead.")
    public suspend fun cancel(fineTuneId: FineTuneId): FineTune?

    /**
     * Get fine-grained status updates for fine-tune job.
     */
    @Deprecated("Use FineTuning instead.")
    public suspend fun fineTuneEvents(fineTuneId: FineTuneId): List

    /**
     * Get fine-grained status updates for fine-tune job.
     */
    @Deprecated("Use FineTuning instead.")
    public fun fineTuneEventsFlow(fineTuneId: FineTuneId): Flow

    /**
     * Delete a fine-tuned model. You must have the Owner role in your organization.
     */
    @Deprecated("Use FineTuning instead.")
    public suspend fun delete(fineTuneModel: ModelId): Boolean
}