openai 0.87.0 → 0.89.0

data/lib/openai/models/fine_tuning/checkpoints/permission_list_response.rb

@@ -34,13 +34,17 @@ module OpenAI
           #   The `checkpoint.permission` object represents a permission for a fine-tuned
           #   model checkpoint.
           #
-          #   @param id [String] The permission identifier, which can be referenced in the API endpoints.
+          #   @param id [String]
+          #     The permission identifier, which can be referenced in the API endpoints.
           #
-          #   @param created_at [Integer] The Unix timestamp (in seconds) for when the permission was created.
+          #   @param created_at [Integer]
+          #     The Unix timestamp (in seconds) for when the permission was created.
           #
-          #   @param project_id [String] The project identifier that the permission is for.
+          #   @param project_id [String]
+          #     The project identifier that the permission is for.
           #
-          #   @param object [Symbol, :"checkpoint.permission"] The object type, which is always "checkpoint.permission".
+          #   @param object [Symbol, :"checkpoint.permission"]
+          #     The object type, which is always "checkpoint.permission".
         end
       end
     end

data/lib/openai/models/fine_tuning/checkpoints/permission_retrieve_params.rb

@@ -41,13 +41,17 @@ module OpenAI
           # @!method initialize(fine_tuned_model_checkpoint:, after: nil, limit: nil, order: nil, project_id: nil, request_options: {})
           #   @param fine_tuned_model_checkpoint [String]
           #
-          #   @param after [String] Identifier for the last permission ID from the previous pagination request.
+          #   @param after [String]
+          #     Identifier for the last permission ID from the previous pagination request.
           #
-          #   @param limit [Integer] Number of permissions to retrieve.
+          #   @param limit [Integer]
+          #     Number of permissions to retrieve.
           #
-          #   @param order [Symbol, OpenAI::Models::FineTuning::Checkpoints::PermissionRetrieveParams::Order] The order in which to retrieve permissions.
+          #   @param order [Symbol, OpenAI::Models::FineTuning::Checkpoints::PermissionRetrieveParams::Order]
+          #     The order in which to retrieve permissions.
           #
-          #   @param project_id [String] The ID of the project to get permissions for.
+          #   @param project_id [String]
+          #     The ID of the project to get permissions for.
           #
           #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
 

data/lib/openai/models/fine_tuning/checkpoints/permission_retrieve_response.rb

@@ -72,13 +72,17 @@ module OpenAI
             #   The `checkpoint.permission` object represents a permission for a fine-tuned
             #   model checkpoint.
             #
-            #   @param id [String] The permission identifier, which can be referenced in the API endpoints.
+            #   @param id [String]
+            #     The permission identifier, which can be referenced in the API endpoints.
             #
-            #   @param created_at [Integer] The Unix timestamp (in seconds) for when the permission was created.
+            #   @param created_at [Integer]
+            #     The Unix timestamp (in seconds) for when the permission was created.
             #
-            #   @param project_id [String] The project identifier that the permission is for.
+            #   @param project_id [String]
+            #     The project identifier that the permission is for.
             #
-            #   @param object [Symbol, :"checkpoint.permission"] The object type, which is always "checkpoint.permission".
+            #   @param object [Symbol, :"checkpoint.permission"]
+            #     The object type, which is always "checkpoint.permission".
           end
         end
       end

data/lib/openai/models/fine_tuning/dpo_hyperparameters.rb

@@ -36,18 +36,23 @@ module OpenAI
         optional :n_epochs, union: -> { OpenAI::FineTuning::DpoHyperparameters::NEpochs }
 
         # @!method initialize(batch_size: nil, beta: nil, learning_rate_multiplier: nil, n_epochs: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::FineTuning::DpoHyperparameters} for more details.
-        #
         #   The hyperparameters used for the DPO fine-tuning job.
         #
-        #   @param batch_size [Symbol, :auto, Integer] Number of examples in each batch. A larger batch size means that model parameter
+        #   @param batch_size [Symbol, :auto, Integer]
+        #     Number of examples in each batch. A larger batch size means that model
+        #     parameters are updated less frequently, but with lower variance.
         #
-        #   @param beta [Symbol, :auto, Float] The beta value for the DPO method. A higher beta value will increase the weight
+        #   @param beta [Symbol, :auto, Float]
+        #     The beta value for the DPO method. A higher beta value will increase the weight
+        #     of the penalty between the policy and reference model.
         #
-        #   @param learning_rate_multiplier [Symbol, :auto, Float] Scaling factor for the learning rate. A smaller learning rate may be useful to a
+        #   @param learning_rate_multiplier [Symbol, :auto, Float]
+        #     Scaling factor for the learning rate. A smaller learning rate may be useful to
+        #     avoid overfitting.
         #
-        #   @param n_epochs [Symbol, :auto, Integer] The number of epochs to train the model for. An epoch refers to one full cycle t
+        #   @param n_epochs [Symbol, :auto, Integer]
+        #     The number of epochs to train the model for. An epoch refers to one full cycle
+        #     through the training dataset.
 
         # Number of examples in each batch. A larger batch size means that model
         # parameters are updated less frequently, but with lower variance.

data/lib/openai/models/fine_tuning/dpo_method.rb

@@ -13,7 +13,8 @@ module OpenAI
         # @!method initialize(hyperparameters: nil)
         #   Configuration for the DPO fine-tuning method.
         #
-        #   @param hyperparameters [OpenAI::Models::FineTuning::DpoHyperparameters] The hyperparameters used for the DPO fine-tuning job.
+        #   @param hyperparameters [OpenAI::Models::FineTuning::DpoHyperparameters]
+        #     The hyperparameters used for the DPO fine-tuning job.
       end
     end
   end

data/lib/openai/models/fine_tuning/fine_tuning_job.rb

@@ -66,7 +66,7 @@ module OpenAI
         # @!attribute result_files
         #   The compiled results file ID(s) for the fine-tuning job. You can retrieve the
         #   results with the
-        #   [Files API](https://platform.openai.com/docs/api-reference/files/retrieve-contents).
+        #   [Files API](https://developers.openai.com/api/reference/resources/files/methods/content).
         #
         #   @return [Array<String>]
         required :result_files, OpenAI::Internal::Type::ArrayOf[String]
@@ -93,7 +93,7 @@ module OpenAI
 
         # @!attribute training_file
         #   The file ID used for training. You can retrieve the training data with the
-        #   [Files API](https://platform.openai.com/docs/api-reference/files/retrieve-contents).
+        #   [Files API](https://developers.openai.com/api/reference/resources/files/methods/content).
         #
         #   @return [String]
         required :training_file, String
@@ -101,7 +101,7 @@ module OpenAI
         # @!attribute validation_file
         #   The file ID used for validation. You can retrieve the validation results with
         #   the
-        #   [Files API](https://platform.openai.com/docs/api-reference/files/retrieve-contents).
+        #   [Files API](https://developers.openai.com/api/reference/resources/files/methods/content).
         #
         #   @return [String, nil]
         required :validation_file, String, nil?: true
@@ -143,49 +143,82 @@ module OpenAI
         optional :method_, -> { OpenAI::FineTuning::FineTuningJob::Method }, api_name: :method
 
         # @!method initialize(id:, created_at:, error:, fine_tuned_model:, finished_at:, hyperparameters:, model:, organization_id:, result_files:, seed:, status:, trained_tokens:, training_file:, validation_file:, estimated_finish: nil, integrations: nil, metadata: nil, method_: nil, object: :"fine_tuning.job")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::FineTuning::FineTuningJob} for more details.
-        #
         #   The `fine_tuning.job` object represents a fine-tuning job that has been created
         #   through the API.
         #
-        #   @param id [String] The object identifier, which can be referenced in the API endpoints.
+        #   @param id [String]
+        #     The object identifier, which can be referenced in the API endpoints.
+        #
+        #   @param created_at [Integer]
+        #     The Unix timestamp (in seconds) for when the fine-tuning job was created.
         #
-        #   @param created_at [Integer] The Unix timestamp (in seconds) for when the fine-tuning job was created.
+        #   @param error [OpenAI::Models::FineTuning::FineTuningJob::Error, nil]
+        #     For fine-tuning jobs that have `failed`, this will contain more information on
+        #     the cause of the failure.
         #
-        #   @param error [OpenAI::Models::FineTuning::FineTuningJob::Error, nil] For fine-tuning jobs that have `failed`, this will contain more information on t
+        #   @param 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.
         #
-        #   @param fine_tuned_model [String, nil] The name of the fine-tuned model that is being created. The value will be null i
+        #   @param finished_at [Integer, nil]
+        #     The Unix timestamp (in seconds) for when the fine-tuning job was finished. The
+        #     value will be null if the fine-tuning job is still running.
         #
-        #   @param finished_at [Integer, nil] The Unix timestamp (in seconds) for when the fine-tuning job was finished. The v
+        #   @param hyperparameters [OpenAI::Models::FineTuning::FineTuningJob::Hyperparameters]
+        #     The hyperparameters used for the fine-tuning job. This value will only be
+        #     returned when running `supervised` jobs.
         #
-        #   @param hyperparameters [OpenAI::Models::FineTuning::FineTuningJob::Hyperparameters] The hyperparameters used for the fine-tuning job. This value will only be return
+        #   @param model [String]
+        #     The base model that is being fine-tuned.
         #
-        #   @param model [String] The base model that is being fine-tuned.
+        #   @param organization_id [String]
+        #     The organization that owns the fine-tuning job.
         #
-        #   @param organization_id [String] The organization that owns the fine-tuning job.
+        #   @param result_files [Array<String>]
+        #     The compiled results file ID(s) for the fine-tuning job. You can retrieve the
+        #     results with the
+        #     [Files API](https://developers.openai.com/api/reference/resources/files/methods/content).
         #
-        #   @param result_files [Array<String>] The compiled results file ID(s) for the fine-tuning job. You can retrieve the re
+        #   @param seed [Integer]
+        #     The seed used for the fine-tuning job.
         #
-        #   @param seed [Integer] The seed used for the fine-tuning job.
+        #   @param status [Symbol, OpenAI::Models::FineTuning::FineTuningJob::Status]
+        #     The current status of the fine-tuning job, which can be either
+        #     `validating_files`, `queued`, `running`, `succeeded`, `failed`, or `cancelled`.
         #
-        #   @param status [Symbol, OpenAI::Models::FineTuning::FineTuningJob::Status] The current status of the fine-tuning job, which can be either `validating_files
+        #   @param trained_tokens [Integer, 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.
         #
-        #   @param trained_tokens [Integer, nil] The total number of billable tokens processed by this fine-tuning job. The value
+        #   @param training_file [String]
+        #     The file ID used for training. You can retrieve the training data with the
+        #     [Files API](https://developers.openai.com/api/reference/resources/files/methods/content).
         #
-        #   @param training_file [String] The file ID used for training. You can retrieve the training data with the [File
+        #   @param validation_file [String, nil]
+        #     The file ID used for validation. You can retrieve the validation results with
+        #     the
+        #     [Files API](https://developers.openai.com/api/reference/resources/files/methods/content).
         #
-        #   @param validation_file [String, nil] The file ID used for validation. You can retrieve the validation results with th
+        #   @param estimated_finish [Integer, nil]
+        #     The Unix timestamp (in seconds) for when the fine-tuning job is estimated to
+        #     finish. The value will be null if the fine-tuning job is not running.
         #
-        #   @param estimated_finish [Integer, nil] The Unix timestamp (in seconds) for when the fine-tuning job is estimated to fin
+        #   @param integrations [Array<OpenAI::Models::FineTuning::FineTuningJobWandbIntegrationObject>, nil]
+        #     A list of integrations to enable for this fine-tuning job.
         #
-        #   @param integrations [Array<OpenAI::Models::FineTuning::FineTuningJobWandbIntegrationObject>, nil] A list of integrations to enable for this fine-tuning job.
+        #   @param metadata [Hash{Symbol=>String}, nil]
+        #     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.
         #
-        #   @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
+        #     Keys are strings with a maximum length of 64 characters. Values are strings with
+        #     a maximum length of 512 characters.
         #
-        #   @param method_ [OpenAI::Models::FineTuning::FineTuningJob::Method] The method used for fine-tuning.
+        #   @param method_ [OpenAI::Models::FineTuning::FineTuningJob::Method]
+        #     The method used for fine-tuning.
         #
-        #   @param object [Symbol, :"fine_tuning.job"] The object type, which is always "fine_tuning.job".
+        #   @param object [Symbol, :"fine_tuning.job"]
+        #     The object type, which is always "fine_tuning.job".
 
         # @see OpenAI::Models::FineTuning::FineTuningJob#error
         class Error < OpenAI::Internal::Type::BaseModel
@@ -209,17 +242,18 @@ module OpenAI
           required :param, String, nil?: true
 
           # @!method initialize(code:, message:, param:)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::FineTuning::FineTuningJob::Error} for more details.
-          #
           #   For fine-tuning jobs that have `failed`, this will contain more information on
           #   the cause of the failure.
           #
-          #   @param code [String] A machine-readable error code.
+          #   @param code [String]
+          #     A machine-readable error code.
           #
-          #   @param message [String] A human-readable error message.
+          #   @param message [String]
+          #     A human-readable error message.
           #
-          #   @param param [String, nil] The parameter that was invalid, usually `training_file` or `validation_file`. Th
+          #   @param param [String, nil]
+          #     The parameter that was invalid, usually `training_file` or `validation_file`.
+          #     This field will be null if the failure was not parameter-specific.
         end
 
         # @see OpenAI::Models::FineTuning::FineTuningJob#hyperparameters
@@ -253,17 +287,20 @@ module OpenAI
           optional :n_epochs, union: -> { OpenAI::FineTuning::FineTuningJob::Hyperparameters::NEpochs }
 
           # @!method initialize(batch_size: nil, learning_rate_multiplier: nil, n_epochs: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::FineTuning::FineTuningJob::Hyperparameters} for more details.
-          #
           #   The hyperparameters used for the fine-tuning job. This value will only be
           #   returned when running `supervised` jobs.
           #
-          #   @param batch_size [Symbol, :auto, Integer, nil] Number of examples in each batch. A larger batch size means that model parameter
+          #   @param batch_size [Symbol, :auto, Integer, nil]
+          #     Number of examples in each batch. A larger batch size means that model
+          #     parameters are updated less frequently, but with lower variance.
           #
-          #   @param learning_rate_multiplier [Symbol, :auto, Float] Scaling factor for the learning rate. A smaller learning rate may be useful to a
+          #   @param learning_rate_multiplier [Symbol, :auto, Float]
+          #     Scaling factor for the learning rate. A smaller learning rate may be useful to
+          #     avoid overfitting.
           #
-          #   @param n_epochs [Symbol, :auto, Integer] The number of epochs to train the model for. An epoch refers to one full cycle
+          #   @param n_epochs [Symbol, :auto, Integer]
+          #     The number of epochs to train the model for. An epoch refers to one full cycle
+          #     through the training dataset.
 
           # Number of examples in each batch. A larger batch size means that model
           # parameters are updated less frequently, but with lower variance.
@@ -358,13 +395,17 @@ module OpenAI
           # @!method initialize(type:, dpo: nil, reinforcement: nil, supervised: nil)
           #   The method used for fine-tuning.
           #
-          #   @param type [Symbol, OpenAI::Models::FineTuning::FineTuningJob::Method::Type] The type of method. Is either `supervised`, `dpo`, or `reinforcement`.
+          #   @param type [Symbol, OpenAI::Models::FineTuning::FineTuningJob::Method::Type]
+          #     The type of method. Is either `supervised`, `dpo`, or `reinforcement`.
           #
-          #   @param dpo [OpenAI::Models::FineTuning::DpoMethod] Configuration for the DPO fine-tuning method.
+          #   @param dpo [OpenAI::Models::FineTuning::DpoMethod]
+          #     Configuration for the DPO fine-tuning method.
           #
-          #   @param reinforcement [OpenAI::Models::FineTuning::ReinforcementMethod] Configuration for the reinforcement fine-tuning method.
+          #   @param reinforcement [OpenAI::Models::FineTuning::ReinforcementMethod]
+          #     Configuration for the reinforcement fine-tuning method.
           #
-          #   @param supervised [OpenAI::Models::FineTuning::SupervisedMethod] Configuration for the supervised fine-tuning method.
+          #   @param supervised [OpenAI::Models::FineTuning::SupervisedMethod]
+          #     Configuration for the supervised fine-tuning method.
 
           # The type of method. Is either `supervised`, `dpo`, or `reinforcement`.
           #

data/lib/openai/models/fine_tuning/fine_tuning_job_event.rb

@@ -50,19 +50,26 @@ module OpenAI
         # @!method initialize(id:, created_at:, level:, message:, data: nil, type: nil, object: :"fine_tuning.job.event")
         #   Fine-tuning job event object
         #
-        #   @param id [String] The object identifier.
+        #   @param id [String]
+        #     The object identifier.
         #
-        #   @param created_at [Integer] The Unix timestamp (in seconds) for when the fine-tuning job was created.
+        #   @param created_at [Integer]
+        #     The Unix timestamp (in seconds) for when the fine-tuning job was created.
         #
-        #   @param level [Symbol, OpenAI::Models::FineTuning::FineTuningJobEvent::Level] The log level of the event.
+        #   @param level [Symbol, OpenAI::Models::FineTuning::FineTuningJobEvent::Level]
+        #     The log level of the event.
         #
-        #   @param message [String] The message of the event.
+        #   @param message [String]
+        #     The message of the event.
         #
-        #   @param data [Object] The data associated with the event.
+        #   @param data [Object]
+        #     The data associated with the event.
         #
-        #   @param type [Symbol, OpenAI::Models::FineTuning::FineTuningJobEvent::Type] The type of event.
+        #   @param type [Symbol, OpenAI::Models::FineTuning::FineTuningJobEvent::Type]
+        #     The type of event.
         #
-        #   @param object [Symbol, :"fine_tuning.job.event"] The object type, which is always "fine_tuning.job.event".
+        #   @param object [Symbol, :"fine_tuning.job.event"]
+        #     The object type, which is always "fine_tuning.job.event".
 
         # The log level of the event.
         #

data/lib/openai/models/fine_tuning/fine_tuning_job_wandb_integration.rb

@@ -34,21 +34,27 @@ module OpenAI
         optional :tags, OpenAI::Internal::Type::ArrayOf[String]
 
         # @!method initialize(project:, entity: nil, name: nil, tags: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::FineTuning::FineTuningJobWandbIntegration} for more details.
-        #
         #   The settings for your integration with Weights and Biases. This payload
         #   specifies the project that metrics will be sent to. Optionally, you can set an
         #   explicit display name for your run, add tags to your run, and set a default
         #   entity (team, username, etc) to be associated with your run.
         #
-        #   @param project [String] The name of the project that the new run will be created under.
+        #   @param project [String]
+        #     The name of the project that the new run will be created under.
         #
-        #   @param entity [String, nil] The entity to use for the run. This allows you to set the team or username of th
+        #   @param entity [String, nil]
+        #     The entity to use for the run. This allows you to set the team or username of
+        #     the WandB user that you would like associated with the run. If not set, the
+        #     default entity for the registered WandB API key is used.
         #
-        #   @param name [String, nil] A display name to set for the run. If not set, we will use the Job ID as the nam
+        #   @param name [String, nil]
+        #     A display name to set for the run. If not set, we will use the Job ID as the
+        #     name.
         #
-        #   @param tags [Array<String>] A list of tags to be attached to the newly created run. These tags are passed th
+        #   @param tags [Array<String>]
+        #     A list of tags to be attached to the newly created run. These tags are passed
+        #     through directly to WandB. Some default tags are generated by OpenAI:
+        #     "openai/finetune", "openai/{base-model}", "openai/{ftjob-abcdef}".
       end
     end
 

data/lib/openai/models/fine_tuning/fine_tuning_job_wandb_integration_object.rb

@@ -20,13 +20,14 @@ module OpenAI
         required :wandb, -> { OpenAI::FineTuning::FineTuningJobWandbIntegration }
 
         # @!method initialize(wandb:, type: :wandb)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::FineTuning::FineTuningJobWandbIntegrationObject} for more
-        #   details.
+        #   @param wandb [OpenAI::Models::FineTuning::FineTuningJobWandbIntegration]
+        #     The settings for your integration with Weights and Biases. This payload
+        #     specifies the project that metrics will be sent to. Optionally, you can set an
+        #     explicit display name for your run, add tags to your run, and set a default
+        #     entity (team, username, etc) to be associated with your run.
         #
-        #   @param wandb [OpenAI::Models::FineTuning::FineTuningJobWandbIntegration] The settings for your integration with Weights and Biases. This payload specifie
-        #
-        #   @param type [Symbol, :wandb] The type of the integration being enabled for the fine-tuning job
+        #   @param type [Symbol, :wandb]
+        #     The type of the integration being enabled for the fine-tuning job
       end
     end