struct OpenAI::FineTuningJob

Overview

Fine-tuning job object

Included Modules

Extended Modules

Defined in:

openai/api/fine_tuning.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]

Instance Method Detail

def created_at : Time #

[View source]
def error : JSON::Any | Nil #

For fine-tuning jobs that have failed, this will contain more information on the cause of the failure.


[View source]
def fine_tuned_model : String | Nil #

The name of the fine-tuned model that is being created. The value will be null if the fine-tuning job is still running.


[View source]
def finished_at : Time | Nil #

[View source]
def hyperparameters : HyperParams | Nil #

The hyperparameters used for the fine-tuning job.


[View source]
def id : String #

The object identifier, which can be referenced in the API endpoints.


[View source]
def model : String #

The base model that is being fine-tuned.


[View source]
def object : String #

The object type, which is always "fine_tuning.job".


[View source]
def organization_id : String #

The organization that owns the fine-tuning job.


[View source]
def result_files : Array(String) #

The compiled results file ID(s) for the fine-tuning job. You can retrieve the results with the Files API.


[View source]
def status : FineTuningStatus #

The current status of the fine-tuning job, which can be either created, pending, running, succeeded, failed, or cancelled.


[View source]
def trained_tokens : Int32 | Nil #

The total number of billable tokens processed by this fine-tuning job. The value will be null if the fine-tuning job is still running.


[View source]
def training_file : String #

The file ID used for training. You can retrieve the training data with the Files API.


[View source]
def validation_file : String | Nil #

The file ID used for validation. You can retrieve the validation results with the Files API.


[View source]