com.theokanning.openai.finetune.FineTuneResult Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of api Show documentation

Basic java objects for the OpenAI GPT APIs

There is a newer version: 0.18.2

package com.theokanning.openai.finetune;

import com.fasterxml.jackson.annotation.JsonProperty;
import com.theokanning.openai.file.File;
import lombok.Data;

import java.util.List;

/**
 * An object describing a fine-tuned model. Returned by multiple fine-tune requests.
 *
 * https://beta.openai.com/docs/api-reference/fine-tunes
 */
@Data
public class FineTuneResult {
    /**
     * The ID of the fine-tuning job.
     */
    String id;

    /**
     * The type of object returned, should be "fine-tune".
     */
    String object;

    /**
     * The name of the base model.
     */
    String model;

    /**
     * The creation time in epoch seconds.
     */
    @JsonProperty("created_at")
    Long createdAt;

    /**
     * List of events in this job's lifecycle. Null when getting a list of fine-tune jobs.
     */
    List events;

    /**
     * The ID of the fine-tuned model, null if tuning job is not finished.
     * This is the id used to call the model.
     */
    @JsonProperty("fine_tuned_model")
    String fineTunedModel;

    /**
     * The specified hyper-parameters for the tuning job.
     */
    HyperParameters hyperparams;

    /**
     * The ID of the organization this model belongs to.
     */
    @JsonProperty("organization_id")
    String organizationId;

    /**
     * Result files for this fine-tune job.
     */
    @JsonProperty("result_files")
    List resultFiles;

    /**
     * The status os the fine-tune job. "pending", "succeeded", or "cancelled"
     */
    String status;

    /**
     * Training files for this fine-tune job.
     */
    @JsonProperty("training_files")
    List trainingFiles;

    /**
     * The last update time in epoch seconds.
     */
    @JsonProperty("updated_at")
    Long updatedAt;

    /**
     * Validation files for this fine-tune job.
     */
    @JsonProperty("validation_files")
    List validationFiles;
}