Constructor Detail

Method Detail

• model

   final JobCreateParams.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<JobCreateParams.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 the method parameter.

• integrations

   final Optional<List<JobCreateParams.Integration>> integrations()

  A list of integrations to enable for your fine-tuning job.

• metadata

   final Optional<JobCreateParams.Metadata> metadata()

  Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

  Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

• method

   final Optional<JobCreateParams.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 suffix of "custom-model-name" would produce a model name like ft: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<JobCreateParams.Model> _model()

  Returns the raw JSON value of model.

  Unlike model, this method doesn't throw if the JSON field has an unexpected type.

• _trainingFile

   final JsonField<String> _trainingFile()

  Returns the raw JSON value of trainingFile.

  Unlike trainingFile, this method doesn't throw if the JSON field has an unexpected type.

• _hyperparameters

  @Deprecated(message = "deprecated") final JsonField<JobCreateParams.Hyperparameters> _hyperparameters()

  Returns the raw JSON value of hyperparameters.

  Unlike hyperparameters, this method doesn't throw if the JSON field has an unexpected type.

• _integrations

   final JsonField<List<JobCreateParams.Integration>> _integrations()

  Returns the raw JSON value of integrations.

  Unlike integrations, this method doesn't throw if the JSON field has an unexpected type.

• _metadata

   final JsonField<JobCreateParams.Metadata> _metadata()

  Returns the raw JSON value of metadata.

  Unlike metadata, this method doesn't throw if the JSON field has an unexpected type.

• _method

   final JsonField<JobCreateParams.Method> _method()

  Returns the raw JSON value of method.

  Unlike method, this method doesn't throw if the JSON field has an unexpected type.

• _seed

   final JsonField<Long> _seed()

  Returns the raw JSON value of seed.

  Unlike seed, this method doesn't throw if the JSON field has an unexpected type.

• _suffix

   final JsonField<String> _suffix()

  Returns the raw JSON value of suffix.

  Unlike suffix, this method doesn't throw if the JSON field has an unexpected type.

• _validationFile

   final JsonField<String> _validationFile()

  Returns the raw JSON value of validationFile.

  Unlike validationFile, this method doesn't throw if the JSON field has an unexpected type.

• _additionalProperties

   final Map<String, JsonValue> _additionalProperties()

• toBuilder

   final JobCreateParams.Body.Builder toBuilder()

• validate

   final JobCreateParams.Body validate()

  Validates that the types of all values in this object match their expected types recursively.

  This method is not forwards compatible with new types from the API for existing fields.

• isValid

   final Boolean isValid()

• equals

   Boolean equals(Object other)

• hashCode

   Integer hashCode()

• toString

   String toString()

• builder

   final static JobCreateParams.Body.Builder builder()

  Returns a mutable builder for constructing an instance of Body.

  The following fields are required:

  .model()
  .trainingFile()