Class FineTuningJobCreateParams
-
- All Implemented Interfaces:
public final class FineTuningJobCreateParamsCreates a fine-tuning job which begins the process of creating a new 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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classFineTuningJobCreateParams.FineTuningJobCreateBodypublic final classFineTuningJobCreateParams.Builderpublic final classFineTuningJobCreateParams.ModelThe name of the model to fine-tune. You can select one of the supported models.
public final classFineTuningJobCreateParams.HyperparametersThe hyperparameters used for the fine-tuning job. This value is now deprecated in favor of
method, and should be passed in under themethodparameter.public final classFineTuningJobCreateParams.Integrationpublic final classFineTuningJobCreateParams.MethodThe method used for fine-tuning.
-
Constructor Summary
Constructors Constructor Description FineTuningJobCreateParams(FineTuningJobCreateParams.FineTuningJobCreateBody body, Headers additionalHeaders, QueryParams additionalQueryParams)
-
Method Summary
Modifier and Type Method Description final FineTuningJobCreateParams.Modelmodel()The name of the model to fine-tune. final StringtrainingFile()The ID of an uploaded file that contains training data. final Optional<FineTuningJobCreateParams.Hyperparameters>hyperparameters()The hyperparameters used for the fine-tuning job. final Optional<List<FineTuningJobCreateParams.Integration>>integrations()A list of integrations to enable for your fine-tuning job. final Optional<FineTuningJobCreateParams.Method>method()The method used for fine-tuning. final Optional<Long>seed()The seed controls the reproducibility of the job. final Optional<String>suffix()A string of up to 64 characters that will be added to your fine-tuned model name. final Optional<String>validationFile()The ID of an uploaded file that contains validation data. final JsonField<FineTuningJobCreateParams.Model>_model()The name of the model to fine-tune. final JsonField<String>_trainingFile()The ID of an uploaded file that contains training data. final JsonField<FineTuningJobCreateParams.Hyperparameters>_hyperparameters()The hyperparameters used for the fine-tuning job. final JsonField<List<FineTuningJobCreateParams.Integration>>_integrations()A list of integrations to enable for your fine-tuning job. final JsonField<FineTuningJobCreateParams.Method>_method()The method used for fine-tuning. final JsonField<Long>_seed()The seed controls the reproducibility of the job. final JsonField<String>_suffix()A string of up to 64 characters that will be added to your fine-tuned model name. final JsonField<String>_validationFile()The ID of an uploaded file that contains validation data. final Map<String, JsonValue>_additionalBodyProperties()final Headers_additionalHeaders()final QueryParams_additionalQueryParams()final FineTuningJobCreateParams.BuildertoBuilder()Booleanequals(Object other)IntegerhashCode()StringtoString()final static FineTuningJobCreateParams.Builderbuilder()-
-
Constructor Detail
-
FineTuningJobCreateParams
FineTuningJobCreateParams(FineTuningJobCreateParams.FineTuningJobCreateBody body, Headers additionalHeaders, QueryParams additionalQueryParams)
-
-
Method Detail
-
model
final FineTuningJobCreateParams.Model model()
The name of the model to fine-tune. You can select one of the supported models.
-
trainingFile
final String trainingFile()
The ID of an uploaded file that contains training data.
See upload file 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.The contents of the file should differ depending on if the model uses the chat, completions format, or if the fine-tuning method uses the preference format.
See the fine-tuning guide for more details.
-
hyperparameters
@Deprecated(message = "deprecated") final Optional<FineTuningJobCreateParams.Hyperparameters> hyperparameters()
The hyperparameters used for the fine-tuning job. This value is now deprecated in favor of
method, and should be passed in under themethodparameter.
-
integrations
final Optional<List<FineTuningJobCreateParams.Integration>> integrations()
A list of integrations to enable for your fine-tuning job.
-
method
final Optional<FineTuningJobCreateParams.Method> method()
The method used for fine-tuning.
-
seed
final Optional<Long> seed()
The seed controls the reproducibility of the job. Passing in the same seed and job parameters should produce the same results, but may differ in rare cases. If a seed is not specified, one will be generated for you.
-
suffix
final Optional<String> suffix()
A string of up to 64 characters that will be added to your fine-tuned model name.
For example, a
suffixof "custom-model-name" would produce a model name likeft:gpt-4o-mini:openai:custom-model-name:7p4lURel.
-
validationFile
final Optional<String> 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 for more details.
-
_model
final JsonField<FineTuningJobCreateParams.Model> _model()
The name of the model to fine-tune. You can select one of the supported models.
-
_trainingFile
final JsonField<String> _trainingFile()
The ID of an uploaded file that contains training data.
See upload file 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.The contents of the file should differ depending on if the model uses the chat, completions format, or if the fine-tuning method uses the preference format.
See the fine-tuning guide for more details.
-
_hyperparameters
@Deprecated(message = "deprecated") final JsonField<FineTuningJobCreateParams.Hyperparameters> _hyperparameters()
The hyperparameters used for the fine-tuning job. This value is now deprecated in favor of
method, and should be passed in under themethodparameter.
-
_integrations
final JsonField<List<FineTuningJobCreateParams.Integration>> _integrations()
A list of integrations to enable for your fine-tuning job.
-
_method
final JsonField<FineTuningJobCreateParams.Method> _method()
The method used for fine-tuning.
-
_seed
final JsonField<Long> _seed()
The seed controls the reproducibility of the job. Passing in the same seed and job parameters should produce the same results, but may differ in rare cases. If a seed is not specified, one will be generated for you.
-
_suffix
final JsonField<String> _suffix()
A string of up to 64 characters that will be added to your fine-tuned model name.
For example, a
suffixof "custom-model-name" would produce a model name likeft:gpt-4o-mini:openai:custom-model-name:7p4lURel.
-
_validationFile
final JsonField<String> _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 for more details.
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
-
_additionalHeaders
final Headers _additionalHeaders()
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
-
toBuilder
final FineTuningJobCreateParams.Builder toBuilder()
-
builder
final static FineTuningJobCreateParams.Builder builder()
-
-
-
-