openai 0.1.0.pre.beta.2 → 0.1.0

data/lib/openai/resources/evals.rb

@@ -1,155 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Resources
-    class Evals
-      # @return [OpenAI::Resources::Evals::Runs]
-      attr_reader :runs
-
-      # Some parameter documentations has been truncated, see
-      # {OpenAI::Models::EvalCreateParams} for more details.
-      #
-      # Create the structure of an evaluation that can be used to test a model's
-      # performance. An evaluation is a set of testing criteria and the config for a
-      # data source, which dictates the schema of the data used in the evaluation. After
-      # creating an evaluation, you can run it on different models and model parameters.
-      # We support several types of graders and datasources. For more information, see
-      # the [Evals guide](https://platform.openai.com/docs/guides/evals).
-      #
-      # @overload create(data_source_config:, testing_criteria:, metadata: nil, name: nil, request_options: {})
-      #
-      # @param data_source_config [OpenAI::Models::EvalCreateParams::DataSourceConfig::Custom, OpenAI::Models::EvalCreateParams::DataSourceConfig::Logs, OpenAI::Models::EvalCreateParams::DataSourceConfig::StoredCompletions] The configuration for the data source used for the evaluation runs. Dictates the
-      #
-      # @param testing_criteria [Array<OpenAI::Models::EvalCreateParams::TestingCriterion::LabelModel, OpenAI::Models::Graders::StringCheckGrader, OpenAI::Models::EvalCreateParams::TestingCriterion::TextSimilarity, OpenAI::Models::EvalCreateParams::TestingCriterion::Python, OpenAI::Models::EvalCreateParams::TestingCriterion::ScoreModel>] A list of graders for all eval runs in this group. Graders can reference variabl
-      #
-      # @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
-      #
-      # @param name [String] The name of the evaluation.
-      #
-      # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [OpenAI::Models::EvalCreateResponse]
-      #
-      # @see OpenAI::Models::EvalCreateParams
-      def create(params)
-        parsed, options = OpenAI::EvalCreateParams.dump_request(params)
-        @client.request(
-          method: :post,
-          path: "evals",
-          body: parsed,
-          model: OpenAI::Models::EvalCreateResponse,
-          options: options
-        )
-      end
-
-      # Get an evaluation by ID.
-      #
-      # @overload retrieve(eval_id, request_options: {})
-      #
-      # @param eval_id [String] The ID of the evaluation to retrieve.
-      #
-      # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [OpenAI::Models::EvalRetrieveResponse]
-      #
-      # @see OpenAI::Models::EvalRetrieveParams
-      def retrieve(eval_id, params = {})
-        @client.request(
-          method: :get,
-          path: ["evals/%1$s", eval_id],
-          model: OpenAI::Models::EvalRetrieveResponse,
-          options: params[:request_options]
-        )
-      end
-
-      # Some parameter documentations has been truncated, see
-      # {OpenAI::Models::EvalUpdateParams} for more details.
-      #
-      # Update certain properties of an evaluation.
-      #
-      # @overload update(eval_id, metadata: nil, name: nil, request_options: {})
-      #
-      # @param eval_id [String] The ID of the evaluation to update.
-      #
-      # @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
-      #
-      # @param name [String] Rename the evaluation.
-      #
-      # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [OpenAI::Models::EvalUpdateResponse]
-      #
-      # @see OpenAI::Models::EvalUpdateParams
-      def update(eval_id, params = {})
-        parsed, options = OpenAI::EvalUpdateParams.dump_request(params)
-        @client.request(
-          method: :post,
-          path: ["evals/%1$s", eval_id],
-          body: parsed,
-          model: OpenAI::Models::EvalUpdateResponse,
-          options: options
-        )
-      end
-
-      # Some parameter documentations has been truncated, see
-      # {OpenAI::Models::EvalListParams} for more details.
-      #
-      # List evaluations for a project.
-      #
-      # @overload list(after: nil, limit: nil, order: nil, order_by: nil, request_options: {})
-      #
-      # @param after [String] Identifier for the last eval from the previous pagination request.
-      #
-      # @param limit [Integer] Number of evals to retrieve.
-      #
-      # @param order [Symbol, OpenAI::Models::EvalListParams::Order] Sort order for evals by timestamp. Use `asc` for ascending order or `desc` for d
-      #
-      # @param order_by [Symbol, OpenAI::Models::EvalListParams::OrderBy] Evals can be ordered by creation time or last updated time. Use
-      #
-      # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [OpenAI::Internal::CursorPage<OpenAI::Models::EvalListResponse>]
-      #
-      # @see OpenAI::Models::EvalListParams
-      def list(params = {})
-        parsed, options = OpenAI::EvalListParams.dump_request(params)
-        @client.request(
-          method: :get,
-          path: "evals",
-          query: parsed,
-          page: OpenAI::Internal::CursorPage,
-          model: OpenAI::Models::EvalListResponse,
-          options: options
-        )
-      end
-
-      # Delete an evaluation.
-      #
-      # @overload delete(eval_id, request_options: {})
-      #
-      # @param eval_id [String] The ID of the evaluation to delete.
-      #
-      # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [OpenAI::Models::EvalDeleteResponse]
-      #
-      # @see OpenAI::Models::EvalDeleteParams
-      def delete(eval_id, params = {})
-        @client.request(
-          method: :delete,
-          path: ["evals/%1$s", eval_id],
-          model: OpenAI::Models::EvalDeleteResponse,
-          options: params[:request_options]
-        )
-      end
-
-      # @api private
-      #
-      # @param client [OpenAI::Client]
-      def initialize(client:)
-        @client = client
-        @runs = OpenAI::Resources::Evals::Runs.new(client: client)
-      end
-    end
-  end
-end

data/lib/openai/resources/files.rb

@@ -1,155 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Resources
-    class Files
-      # Some parameter documentations has been truncated, see
-      # {OpenAI::Models::FileCreateParams} for more details.
-      #
-      # Upload a file that can be used across various endpoints. Individual files can be
-      # up to 512 MB, and the size of all files uploaded by one organization can be up
-      # to 100 GB.
-      #
-      # The Assistants API supports files up to 2 million tokens and of specific file
-      # types. See the
-      # [Assistants Tools guide](https://platform.openai.com/docs/assistants/tools) for
-      # details.
-      #
-      # The Fine-tuning API only supports `.jsonl` files. The input also has certain
-      # required formats for fine-tuning
-      # [chat](https://platform.openai.com/docs/api-reference/fine-tuning/chat-input) or
-      # [completions](https://platform.openai.com/docs/api-reference/fine-tuning/completions-input)
-      # models.
-      #
-      # The Batch API only supports `.jsonl` files up to 200 MB in size. The input also
-      # has a specific required
-      # [format](https://platform.openai.com/docs/api-reference/batch/request-input).
-      #
-      # Please [contact us](https://help.openai.com/) if you need to increase these
-      # storage limits.
-      #
-      # @overload create(file:, purpose:, request_options: {})
-      #
-      # @param file [Pathname, StringIO, IO, String, OpenAI::FilePart] The File object (not file name) to be uploaded.
-      #
-      # @param purpose [Symbol, OpenAI::Models::FilePurpose] The intended purpose of the uploaded file. One of: - `assistants`: Used in the A
-      #
-      # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [OpenAI::Models::FileObject]
-      #
-      # @see OpenAI::Models::FileCreateParams
-      def create(params)
-        parsed, options = OpenAI::FileCreateParams.dump_request(params)
-        @client.request(
-          method: :post,
-          path: "files",
-          headers: {"content-type" => "multipart/form-data"},
-          body: parsed,
-          model: OpenAI::FileObject,
-          options: options
-        )
-      end
-
-      # Returns information about a specific file.
-      #
-      # @overload retrieve(file_id, request_options: {})
-      #
-      # @param file_id [String] The ID of the file to use for this request.
-      #
-      # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [OpenAI::Models::FileObject]
-      #
-      # @see OpenAI::Models::FileRetrieveParams
-      def retrieve(file_id, params = {})
-        @client.request(
-          method: :get,
-          path: ["files/%1$s", file_id],
-          model: OpenAI::FileObject,
-          options: params[:request_options]
-        )
-      end
-
-      # Some parameter documentations has been truncated, see
-      # {OpenAI::Models::FileListParams} for more details.
-      #
-      # Returns a list of files.
-      #
-      # @overload list(after: nil, limit: nil, order: nil, purpose: nil, request_options: {})
-      #
-      # @param after [String] A cursor for use in pagination. `after` is an object ID that defines your place
-      #
-      # @param limit [Integer] A limit on the number of objects to be returned. Limit can range between 1 and 1
-      #
-      # @param order [Symbol, OpenAI::Models::FileListParams::Order] Sort order by the `created_at` timestamp of the objects. `asc` for ascending ord
-      #
-      # @param purpose [String] Only return files with the given purpose.
-      #
-      # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [OpenAI::Internal::CursorPage<OpenAI::Models::FileObject>]
-      #
-      # @see OpenAI::Models::FileListParams
-      def list(params = {})
-        parsed, options = OpenAI::FileListParams.dump_request(params)
-        @client.request(
-          method: :get,
-          path: "files",
-          query: parsed,
-          page: OpenAI::Internal::CursorPage,
-          model: OpenAI::FileObject,
-          options: options
-        )
-      end
-
-      # Delete a file.
-      #
-      # @overload delete(file_id, request_options: {})
-      #
-      # @param file_id [String] The ID of the file to use for this request.
-      #
-      # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [OpenAI::Models::FileDeleted]
-      #
-      # @see OpenAI::Models::FileDeleteParams
-      def delete(file_id, params = {})
-        @client.request(
-          method: :delete,
-          path: ["files/%1$s", file_id],
-          model: OpenAI::FileDeleted,
-          options: params[:request_options]
-        )
-      end
-
-      # Returns the contents of the specified file.
-      #
-      # @overload content(file_id, request_options: {})
-      #
-      # @param file_id [String] The ID of the file to use for this request.
-      #
-      # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [StringIO]
-      #
-      # @see OpenAI::Models::FileContentParams
-      def content(file_id, params = {})
-        @client.request(
-          method: :get,
-          path: ["files/%1$s/content", file_id],
-          headers: {"accept" => "application/binary"},
-          model: StringIO,
-          options: params[:request_options]
-        )
-      end
-
-      # @api private
-      #
-      # @param client [OpenAI::Client]
-      def initialize(client:)
-        @client = client
-      end
-    end
-  end
-end

data/lib/openai/resources/fine_tuning/alpha/graders.rb

@@ -1,66 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Resources
-    class FineTuning
-      class Alpha
-        class Graders
-          # Run a grader.
-          #
-          # @overload run(grader:, model_sample:, reference_answer:, request_options: {})
-          #
-          # @param grader [OpenAI::Models::Graders::StringCheckGrader, OpenAI::Models::Graders::TextSimilarityGrader, OpenAI::Models::Graders::PythonGrader, OpenAI::Models::Graders::ScoreModelGrader, OpenAI::Models::Graders::MultiGrader] The grader used for the fine-tuning job.
-          #
-          # @param model_sample [String] The model sample to be evaluated.
-          #
-          # @param reference_answer [String, Object, Array<Object>, Float] The reference answer for the evaluation.
-          #
-          # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
-          #
-          # @return [OpenAI::Models::FineTuning::Alpha::GraderRunResponse]
-          #
-          # @see OpenAI::Models::FineTuning::Alpha::GraderRunParams
-          def run(params)
-            parsed, options = OpenAI::FineTuning::Alpha::GraderRunParams.dump_request(params)
-            @client.request(
-              method: :post,
-              path: "fine_tuning/alpha/graders/run",
-              body: parsed,
-              model: OpenAI::Models::FineTuning::Alpha::GraderRunResponse,
-              options: options
-            )
-          end
-
-          # Validate a grader.
-          #
-          # @overload validate(grader:, request_options: {})
-          #
-          # @param grader [OpenAI::Models::Graders::StringCheckGrader, OpenAI::Models::Graders::TextSimilarityGrader, OpenAI::Models::Graders::PythonGrader, OpenAI::Models::Graders::ScoreModelGrader, OpenAI::Models::Graders::MultiGrader] The grader used for the fine-tuning job.
-          #
-          # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
-          #
-          # @return [OpenAI::Models::FineTuning::Alpha::GraderValidateResponse]
-          #
-          # @see OpenAI::Models::FineTuning::Alpha::GraderValidateParams
-          def validate(params)
-            parsed, options = OpenAI::FineTuning::Alpha::GraderValidateParams.dump_request(params)
-            @client.request(
-              method: :post,
-              path: "fine_tuning/alpha/graders/validate",
-              body: parsed,
-              model: OpenAI::Models::FineTuning::Alpha::GraderValidateResponse,
-              options: options
-            )
-          end
-
-          # @api private
-          #
-          # @param client [OpenAI::Client]
-          def initialize(client:)
-            @client = client
-          end
-        end
-      end
-    end
-  end
-end

data/lib/openai/resources/fine_tuning/alpha.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Resources
-    class FineTuning
-      class Alpha
-        # @return [OpenAI::Resources::FineTuning::Alpha::Graders]
-        attr_reader :graders
-
-        # @api private
-        #
-        # @param client [OpenAI::Client]
-        def initialize(client:)
-          @client = client
-          @graders = OpenAI::Resources::FineTuning::Alpha::Graders.new(client: client)
-        end
-      end
-    end
-  end
-end

data/lib/openai/resources/fine_tuning/checkpoints/permissions.rb

@@ -1,125 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Resources
-    class FineTuning
-      class Checkpoints
-        class Permissions
-          # Some parameter documentations has been truncated, see
-          # {OpenAI::Models::FineTuning::Checkpoints::PermissionCreateParams} for more
-          # details.
-          #
-          # **NOTE:** Calling this endpoint requires an [admin API key](../admin-api-keys).
-          #
-          # This enables organization owners to share fine-tuned models with other projects
-          # in their organization.
-          #
-          # @overload create(fine_tuned_model_checkpoint, project_ids:, request_options: {})
-          #
-          # @param fine_tuned_model_checkpoint [String] The ID of the fine-tuned model checkpoint to create a permission for.
-          #
-          # @param project_ids [Array<String>] The project identifiers to grant access to.
-          #
-          # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
-          #
-          # @return [OpenAI::Internal::Page<OpenAI::Models::FineTuning::Checkpoints::PermissionCreateResponse>]
-          #
-          # @see OpenAI::Models::FineTuning::Checkpoints::PermissionCreateParams
-          def create(fine_tuned_model_checkpoint, params)
-            parsed, options = OpenAI::FineTuning::Checkpoints::PermissionCreateParams.dump_request(params)
-            @client.request(
-              method: :post,
-              path: ["fine_tuning/checkpoints/%1$s/permissions", fine_tuned_model_checkpoint],
-              body: parsed,
-              page: OpenAI::Internal::Page,
-              model: OpenAI::Models::FineTuning::Checkpoints::PermissionCreateResponse,
-              options: options
-            )
-          end
-
-          # Some parameter documentations has been truncated, see
-          # {OpenAI::Models::FineTuning::Checkpoints::PermissionRetrieveParams} for more
-          # details.
-          #
-          # **NOTE:** This endpoint requires an [admin API key](../admin-api-keys).
-          #
-          # Organization owners can use this endpoint to view all permissions for a
-          # fine-tuned model checkpoint.
-          #
-          # @overload retrieve(fine_tuned_model_checkpoint, after: nil, limit: nil, order: nil, project_id: nil, request_options: {})
-          #
-          # @param fine_tuned_model_checkpoint [String] The ID of the fine-tuned model checkpoint to get permissions for.
-          #
-          # @param after [String] Identifier for the last permission ID from the previous pagination request.
-          #
-          # @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 project_id [String] The ID of the project to get permissions for.
-          #
-          # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
-          #
-          # @return [OpenAI::Models::FineTuning::Checkpoints::PermissionRetrieveResponse]
-          #
-          # @see OpenAI::Models::FineTuning::Checkpoints::PermissionRetrieveParams
-          def retrieve(fine_tuned_model_checkpoint, params = {})
-            parsed, options = OpenAI::FineTuning::Checkpoints::PermissionRetrieveParams.dump_request(params)
-            @client.request(
-              method: :get,
-              path: ["fine_tuning/checkpoints/%1$s/permissions", fine_tuned_model_checkpoint],
-              query: parsed,
-              model: OpenAI::Models::FineTuning::Checkpoints::PermissionRetrieveResponse,
-              options: options
-            )
-          end
-
-          # Some parameter documentations has been truncated, see
-          # {OpenAI::Models::FineTuning::Checkpoints::PermissionDeleteParams} for more
-          # details.
-          #
-          # **NOTE:** This endpoint requires an [admin API key](../admin-api-keys).
-          #
-          # Organization owners can use this endpoint to delete a permission for a
-          # fine-tuned model checkpoint.
-          #
-          # @overload delete(permission_id, fine_tuned_model_checkpoint:, request_options: {})
-          #
-          # @param permission_id [String] The ID of the fine-tuned model checkpoint permission to delete.
-          #
-          # @param fine_tuned_model_checkpoint [String] The ID of the fine-tuned model checkpoint to delete a permission for.
-          #
-          # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
-          #
-          # @return [OpenAI::Models::FineTuning::Checkpoints::PermissionDeleteResponse]
-          #
-          # @see OpenAI::Models::FineTuning::Checkpoints::PermissionDeleteParams
-          def delete(permission_id, params)
-            parsed, options = OpenAI::FineTuning::Checkpoints::PermissionDeleteParams.dump_request(params)
-            fine_tuned_model_checkpoint =
-              parsed.delete(:fine_tuned_model_checkpoint) do
-                raise ArgumentError.new("missing required path argument #{_1}")
-              end
-            @client.request(
-              method: :delete,
-              path: [
-                "fine_tuning/checkpoints/%1$s/permissions/%2$s",
-                fine_tuned_model_checkpoint,
-                permission_id
-              ],
-              model: OpenAI::Models::FineTuning::Checkpoints::PermissionDeleteResponse,
-              options: options
-            )
-          end
-
-          # @api private
-          #
-          # @param client [OpenAI::Client]
-          def initialize(client:)
-            @client = client
-          end
-        end
-      end
-    end
-  end
-end

data/lib/openai/resources/fine_tuning/checkpoints.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Resources
-    class FineTuning
-      class Checkpoints
-        # @return [OpenAI::Resources::FineTuning::Checkpoints::Permissions]
-        attr_reader :permissions
-
-        # @api private
-        #
-        # @param client [OpenAI::Client]
-        def initialize(client:)
-          @client = client
-          @permissions = OpenAI::Resources::FineTuning::Checkpoints::Permissions.new(client: client)
-        end
-      end
-    end
-  end
-end

data/lib/openai/resources/fine_tuning/jobs/checkpoints.rb

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Resources
-    class FineTuning
-      class Jobs
-        class Checkpoints
-          # Some parameter documentations has been truncated, see
-          # {OpenAI::Models::FineTuning::Jobs::CheckpointListParams} for more details.
-          #
-          # List checkpoints for a fine-tuning job.
-          #
-          # @overload list(fine_tuning_job_id, after: nil, limit: nil, request_options: {})
-          #
-          # @param fine_tuning_job_id [String] The ID of the fine-tuning job to get checkpoints for.
-          #
-          # @param after [String] Identifier for the last checkpoint ID from the previous pagination request.
-          #
-          # @param limit [Integer] Number of checkpoints to retrieve.
-          #
-          # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
-          #
-          # @return [OpenAI::Internal::CursorPage<OpenAI::Models::FineTuning::Jobs::FineTuningJobCheckpoint>]
-          #
-          # @see OpenAI::Models::FineTuning::Jobs::CheckpointListParams
-          def list(fine_tuning_job_id, params = {})
-            parsed, options = OpenAI::FineTuning::Jobs::CheckpointListParams.dump_request(params)
-            @client.request(
-              method: :get,
-              path: ["fine_tuning/jobs/%1$s/checkpoints", fine_tuning_job_id],
-              query: parsed,
-              page: OpenAI::Internal::CursorPage,
-              model: OpenAI::FineTuning::Jobs::FineTuningJobCheckpoint,
-              options: options
-            )
-          end
-
-          # @api private
-          #
-          # @param client [OpenAI::Client]
-          def initialize(client:)
-            @client = client
-          end
-        end
-      end
-    end
-  end
-end