openai 0.2.0 → 0.4.0.pre.beta.1

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

@@ -0,0 +1,384 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module FineTuning
+      # @see OpenAI::Resources::FineTuning::Jobs#create
+      class FineTuningJob < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The object identifier, which can be referenced in the API endpoints.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute created_at
+        #   The Unix timestamp (in seconds) for when the fine-tuning job was created.
+        #
+        #   @return [Integer]
+        required :created_at, Integer
+
+        # @!attribute error
+        #   For fine-tuning jobs that have `failed`, this will contain more information on
+        #   the cause of the failure.
+        #
+        #   @return [OpenAI::Models::FineTuning::FineTuningJob::Error, nil]
+        required :error, -> { OpenAI::FineTuning::FineTuningJob::Error }, nil?: true
+
+        # @!attribute fine_tuned_model
+        #   The name of the fine-tuned model that is being created. The value will be null
+        #   if the fine-tuning job is still running.
+        #
+        #   @return [String, nil]
+        required :fine_tuned_model, String, nil?: true
+
+        # @!attribute finished_at
+        #   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.
+        #
+        #   @return [Integer, nil]
+        required :finished_at, Integer, nil?: true
+
+        # @!attribute hyperparameters
+        #   The hyperparameters used for the fine-tuning job. This value will only be
+        #   returned when running `supervised` jobs.
+        #
+        #   @return [OpenAI::Models::FineTuning::FineTuningJob::Hyperparameters]
+        required :hyperparameters, -> { OpenAI::FineTuning::FineTuningJob::Hyperparameters }
+
+        # @!attribute model
+        #   The base model that is being fine-tuned.
+        #
+        #   @return [String]
+        required :model, String
+
+        # @!attribute object
+        #   The object type, which is always "fine_tuning.job".
+        #
+        #   @return [Symbol, :"fine_tuning.job"]
+        required :object, const: :"fine_tuning.job"
+
+        # @!attribute organization_id
+        #   The organization that owns the fine-tuning job.
+        #
+        #   @return [String]
+        required :organization_id, String
+
+        # @!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).
+        #
+        #   @return [Array<String>]
+        required :result_files, OpenAI::Internal::Type::ArrayOf[String]
+
+        # @!attribute seed
+        #   The seed used for the fine-tuning job.
+        #
+        #   @return [Integer]
+        required :seed, Integer
+
+        # @!attribute status
+        #   The current status of the fine-tuning job, which can be either
+        #   `validating_files`, `queued`, `running`, `succeeded`, `failed`, or `cancelled`.
+        #
+        #   @return [Symbol, OpenAI::Models::FineTuning::FineTuningJob::Status]
+        required :status, enum: -> { OpenAI::FineTuning::FineTuningJob::Status }
+
+        # @!attribute trained_tokens
+        #   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.
+        #
+        #   @return [Integer, nil]
+        required :trained_tokens, Integer, nil?: true
+
+        # @!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).
+        #
+        #   @return [String]
+        required :training_file, String
+
+        # @!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).
+        #
+        #   @return [String, nil]
+        required :validation_file, String, nil?: true
+
+        # @!attribute estimated_finish
+        #   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.
+        #
+        #   @return [Integer, nil]
+        optional :estimated_finish, Integer, nil?: true
+
+        # @!attribute integrations
+        #   A list of integrations to enable for this fine-tuning job.
+        #
+        #   @return [Array<OpenAI::Models::FineTuning::FineTuningJobWandbIntegrationObject>, nil]
+        optional :integrations,
+                 -> {
+                   OpenAI::Internal::Type::ArrayOf[OpenAI::FineTuning::FineTuningJobWandbIntegrationObject]
+                 },
+                 nil?: true
+
+        # @!attribute 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.
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
+
+        # @!attribute method_
+        #   The method used for fine-tuning.
+        #
+        #   @return [OpenAI::Models::FineTuning::FineTuningJob::Method, nil]
+        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 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 t
+        #
+        #   @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 v
+        #
+        #   @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 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 re
+        #
+        #   @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
+        #
+        #   @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 [File
+        #
+        #   @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 fin
+        #
+        #   @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
+        #
+        #   @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".
+
+        # @see OpenAI::Models::FineTuning::FineTuningJob#error
+        class Error < OpenAI::Internal::Type::BaseModel
+          # @!attribute code
+          #   A machine-readable error code.
+          #
+          #   @return [String]
+          required :code, String
+
+          # @!attribute message
+          #   A human-readable error message.
+          #
+          #   @return [String]
+          required :message, String
+
+          # @!attribute param
+          #   The parameter that was invalid, usually `training_file` or `validation_file`.
+          #   This field will be null if the failure was not parameter-specific.
+          #
+          #   @return [String, nil]
+          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 message [String] A human-readable error message.
+          #
+          #   @param param [String, nil] The parameter that was invalid, usually `training_file` or `validation_file`. Th
+        end
+
+        # @see OpenAI::Models::FineTuning::FineTuningJob#hyperparameters
+        class Hyperparameters < OpenAI::Internal::Type::BaseModel
+          # @!attribute batch_size
+          #   Number of examples in each batch. A larger batch size means that model
+          #   parameters are updated less frequently, but with lower variance.
+          #
+          #   @return [Object, Symbol, :auto, Integer, nil]
+          optional :batch_size,
+                   union: -> { OpenAI::FineTuning::FineTuningJob::Hyperparameters::BatchSize },
+                   nil?: true
+
+          # @!attribute learning_rate_multiplier
+          #   Scaling factor for the learning rate. A smaller learning rate may be useful to
+          #   avoid overfitting.
+          #
+          #   @return [Symbol, :auto, Float, nil]
+          optional :learning_rate_multiplier,
+                   union: -> { OpenAI::FineTuning::FineTuningJob::Hyperparameters::LearningRateMultiplier }
+
+          # @!attribute n_epochs
+          #   The number of epochs to train the model for. An epoch refers to one full cycle
+          #   through the training dataset.
+          #
+          #   @return [Symbol, :auto, Integer, nil]
+          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 [Object, Symbol, :auto, Integer, nil] Number of examples in each batch. A larger batch size means that model parameter
+          #
+          #   @param learning_rate_multiplier [Symbol, :auto, Float] Scaling factor for the learning rate. A smaller learning rate may be useful to a
+          #
+          #   @param n_epochs [Symbol, :auto, Integer] The number of epochs to train the model for. An epoch refers to one full cycle
+
+          # Number of examples in each batch. A larger batch size means that model
+          # parameters are updated less frequently, but with lower variance.
+          #
+          # @see OpenAI::Models::FineTuning::FineTuningJob::Hyperparameters#batch_size
+          module BatchSize
+            extend OpenAI::Internal::Type::Union
+
+            variant OpenAI::Internal::Type::Unknown
+
+            variant const: :auto
+
+            variant Integer
+
+            # @!method self.variants
+            #   @return [Array(Object, Symbol, :auto, Integer)]
+          end
+
+          # Scaling factor for the learning rate. A smaller learning rate may be useful to
+          # avoid overfitting.
+          #
+          # @see OpenAI::Models::FineTuning::FineTuningJob::Hyperparameters#learning_rate_multiplier
+          module LearningRateMultiplier
+            extend OpenAI::Internal::Type::Union
+
+            variant const: :auto
+
+            variant Float
+
+            # @!method self.variants
+            #   @return [Array(Symbol, :auto, Float)]
+          end
+
+          # The number of epochs to train the model for. An epoch refers to one full cycle
+          # through the training dataset.
+          #
+          # @see OpenAI::Models::FineTuning::FineTuningJob::Hyperparameters#n_epochs
+          module NEpochs
+            extend OpenAI::Internal::Type::Union
+
+            variant const: :auto
+
+            variant Integer
+
+            # @!method self.variants
+            #   @return [Array(Symbol, :auto, Integer)]
+          end
+        end
+
+        # The current status of the fine-tuning job, which can be either
+        # `validating_files`, `queued`, `running`, `succeeded`, `failed`, or `cancelled`.
+        #
+        # @see OpenAI::Models::FineTuning::FineTuningJob#status
+        module Status
+          extend OpenAI::Internal::Type::Enum
+
+          VALIDATING_FILES = :validating_files
+          QUEUED = :queued
+          RUNNING = :running
+          SUCCEEDED = :succeeded
+          FAILED = :failed
+          CANCELLED = :cancelled
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see OpenAI::Models::FineTuning::FineTuningJob#method_
+        class Method < OpenAI::Internal::Type::BaseModel
+          # @!attribute type
+          #   The type of method. Is either `supervised`, `dpo`, or `reinforcement`.
+          #
+          #   @return [Symbol, OpenAI::Models::FineTuning::FineTuningJob::Method::Type]
+          required :type, enum: -> { OpenAI::FineTuning::FineTuningJob::Method::Type }
+
+          # @!attribute dpo
+          #   Configuration for the DPO fine-tuning method.
+          #
+          #   @return [OpenAI::Models::FineTuning::DpoMethod, nil]
+          optional :dpo, -> { OpenAI::FineTuning::DpoMethod }
+
+          # @!attribute reinforcement
+          #   Configuration for the reinforcement fine-tuning method.
+          #
+          #   @return [OpenAI::Models::FineTuning::ReinforcementMethod, nil]
+          optional :reinforcement, -> { OpenAI::FineTuning::ReinforcementMethod }
+
+          # @!attribute supervised
+          #   Configuration for the supervised fine-tuning method.
+          #
+          #   @return [OpenAI::Models::FineTuning::SupervisedMethod, nil]
+          optional :supervised, -> { OpenAI::FineTuning::SupervisedMethod }
+
+          # @!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 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 supervised [OpenAI::Models::FineTuning::SupervisedMethod] Configuration for the supervised fine-tuning method.
+
+          # The type of method. Is either `supervised`, `dpo`, or `reinforcement`.
+          #
+          # @see OpenAI::Models::FineTuning::FineTuningJob::Method#type
+          module Type
+            extend OpenAI::Internal::Type::Enum
+
+            SUPERVISED = :supervised
+            DPO = :dpo
+            REINFORCEMENT = :reinforcement
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+
+    FineTuningJob = FineTuning::FineTuningJob
+  end
+end

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

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module FineTuning
+      # @see OpenAI::Resources::FineTuning::Jobs#list_events
+      class FineTuningJobEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The object identifier.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute created_at
+        #   The Unix timestamp (in seconds) for when the fine-tuning job was created.
+        #
+        #   @return [Integer]
+        required :created_at, Integer
+
+        # @!attribute level
+        #   The log level of the event.
+        #
+        #   @return [Symbol, OpenAI::Models::FineTuning::FineTuningJobEvent::Level]
+        required :level, enum: -> { OpenAI::FineTuning::FineTuningJobEvent::Level }
+
+        # @!attribute message
+        #   The message of the event.
+        #
+        #   @return [String]
+        required :message, String
+
+        # @!attribute object
+        #   The object type, which is always "fine_tuning.job.event".
+        #
+        #   @return [Symbol, :"fine_tuning.job.event"]
+        required :object, const: :"fine_tuning.job.event"
+
+        # @!attribute data
+        #   The data associated with the event.
+        #
+        #   @return [Object, nil]
+        optional :data, OpenAI::Internal::Type::Unknown
+
+        # @!attribute type
+        #   The type of event.
+        #
+        #   @return [Symbol, OpenAI::Models::FineTuning::FineTuningJobEvent::Type, nil]
+        optional :type, enum: -> { OpenAI::FineTuning::FineTuningJobEvent::Type }
+
+        # @!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 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 message [String] The message of the event.
+        #
+        #   @param data [Object] The data associated with the 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".
+
+        # The log level of the event.
+        #
+        # @see OpenAI::Models::FineTuning::FineTuningJobEvent#level
+        module Level
+          extend OpenAI::Internal::Type::Enum
+
+          INFO = :info
+          WARN = :warn
+          ERROR = :error
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The type of event.
+        #
+        # @see OpenAI::Models::FineTuning::FineTuningJobEvent#type
+        module Type
+          extend OpenAI::Internal::Type::Enum
+
+          MESSAGE = :message
+          METRICS = :metrics
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+
+    FineTuningJobEvent = FineTuning::FineTuningJobEvent
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module FineTuning
+      FineTuningJobIntegration = OpenAI::Models::FineTuning::FineTuningJobWandbIntegrationObject
+    end
+
+    FineTuningJobIntegration = FineTuning::FineTuningJobIntegration
+  end
+end

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module FineTuning
+      class FineTuningJobWandbIntegration < OpenAI::Internal::Type::BaseModel
+        # @!attribute project
+        #   The name of the project that the new run will be created under.
+        #
+        #   @return [String]
+        required :project, String
+
+        # @!attribute entity
+        #   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.
+        #
+        #   @return [String, nil]
+        optional :entity, String, nil?: true
+
+        # @!attribute name
+        #   A display name to set for the run. If not set, we will use the Job ID as the
+        #   name.
+        #
+        #   @return [String, nil]
+        optional :name, String, nil?: true
+
+        # @!attribute tags
+        #   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}".
+        #
+        #   @return [Array<String>, nil]
+        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 entity [String, nil] The entity to use for the run. This allows you to set the team or username of th
+        #
+        #   @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 tags [Array<String>] A list of tags to be attached to the newly created run. These tags are passed th
+      end
+    end
+
+    FineTuningJobWandbIntegration = FineTuning::FineTuningJobWandbIntegration
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module FineTuning
+      class FineTuningJobWandbIntegrationObject < OpenAI::Internal::Type::BaseModel
+        # @!attribute type
+        #   The type of the integration being enabled for the fine-tuning job
+        #
+        #   @return [Symbol, :wandb]
+        required :type, const: :wandb
+
+        # @!attribute wandb
+        #   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.
+        #
+        #   @return [OpenAI::Models::FineTuning::FineTuningJobWandbIntegration]
+        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 specifie
+        #
+        #   @param type [Symbol, :wandb] The type of the integration being enabled for the fine-tuning job
+      end
+    end
+
+    FineTuningJobWandbIntegrationObject = FineTuning::FineTuningJobWandbIntegrationObject
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module FineTuning
+      # @see OpenAI::Resources::FineTuning::Jobs#cancel
+      class JobCancelParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        # @!method initialize(request_options: {})
+        #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end