openai 0.2.0 → 0.4.0.pre.beta.1

data/sig/openai/models/fine_tuning/reinforcement_method.rbs

@@ -0,0 +1,44 @@
+module OpenAI
+  module Models
+    module FineTuning
+      type reinforcement_method =
+        {
+          grader: OpenAI::Models::FineTuning::ReinforcementMethod::grader,
+          hyperparameters: OpenAI::FineTuning::ReinforcementHyperparameters
+        }
+
+      class ReinforcementMethod < OpenAI::Internal::Type::BaseModel
+        attr_accessor grader: OpenAI::Models::FineTuning::ReinforcementMethod::grader
+
+        attr_reader hyperparameters: OpenAI::FineTuning::ReinforcementHyperparameters?
+
+        def hyperparameters=: (
+          OpenAI::FineTuning::ReinforcementHyperparameters
+        ) -> OpenAI::FineTuning::ReinforcementHyperparameters
+
+        def initialize: (
+          grader: OpenAI::Models::FineTuning::ReinforcementMethod::grader,
+          ?hyperparameters: OpenAI::FineTuning::ReinforcementHyperparameters
+        ) -> void
+
+        def to_hash: -> {
+          grader: OpenAI::Models::FineTuning::ReinforcementMethod::grader,
+          hyperparameters: OpenAI::FineTuning::ReinforcementHyperparameters
+        }
+
+        type grader =
+          OpenAI::Graders::StringCheckGrader
+          | OpenAI::Graders::TextSimilarityGrader
+          | OpenAI::Graders::PythonGrader
+          | OpenAI::Graders::ScoreModelGrader
+          | OpenAI::Graders::MultiGrader
+
+        module Grader
+          extend OpenAI::Internal::Type::Union
+
+          def self?.variants: -> ::Array[OpenAI::Models::FineTuning::ReinforcementMethod::grader]
+        end
+      end
+    end
+  end
+end

data/sig/openai/models/fine_tuning/supervised_hyperparameters.rbs

@@ -0,0 +1,68 @@
+module OpenAI
+  module Models
+    module FineTuning
+      type supervised_hyperparameters =
+        {
+          batch_size: OpenAI::Models::FineTuning::SupervisedHyperparameters::batch_size,
+          learning_rate_multiplier: OpenAI::Models::FineTuning::SupervisedHyperparameters::learning_rate_multiplier,
+          n_epochs: OpenAI::Models::FineTuning::SupervisedHyperparameters::n_epochs
+        }
+
+      class SupervisedHyperparameters < OpenAI::Internal::Type::BaseModel
+        attr_reader batch_size: OpenAI::Models::FineTuning::SupervisedHyperparameters::batch_size?
+
+        def batch_size=: (
+          OpenAI::Models::FineTuning::SupervisedHyperparameters::batch_size
+        ) -> OpenAI::Models::FineTuning::SupervisedHyperparameters::batch_size
+
+        attr_reader learning_rate_multiplier: OpenAI::Models::FineTuning::SupervisedHyperparameters::learning_rate_multiplier?
+
+        def learning_rate_multiplier=: (
+          OpenAI::Models::FineTuning::SupervisedHyperparameters::learning_rate_multiplier
+        ) -> OpenAI::Models::FineTuning::SupervisedHyperparameters::learning_rate_multiplier
+
+        attr_reader n_epochs: OpenAI::Models::FineTuning::SupervisedHyperparameters::n_epochs?
+
+        def n_epochs=: (
+          OpenAI::Models::FineTuning::SupervisedHyperparameters::n_epochs
+        ) -> OpenAI::Models::FineTuning::SupervisedHyperparameters::n_epochs
+
+        def initialize: (
+          ?batch_size: OpenAI::Models::FineTuning::SupervisedHyperparameters::batch_size,
+          ?learning_rate_multiplier: OpenAI::Models::FineTuning::SupervisedHyperparameters::learning_rate_multiplier,
+          ?n_epochs: OpenAI::Models::FineTuning::SupervisedHyperparameters::n_epochs
+        ) -> void
+
+        def to_hash: -> {
+          batch_size: OpenAI::Models::FineTuning::SupervisedHyperparameters::batch_size,
+          learning_rate_multiplier: OpenAI::Models::FineTuning::SupervisedHyperparameters::learning_rate_multiplier,
+          n_epochs: OpenAI::Models::FineTuning::SupervisedHyperparameters::n_epochs
+        }
+
+        type batch_size = :auto | Integer
+
+        module BatchSize
+          extend OpenAI::Internal::Type::Union
+
+          def self?.variants: -> ::Array[OpenAI::Models::FineTuning::SupervisedHyperparameters::batch_size]
+        end
+
+        type learning_rate_multiplier = :auto | Float
+
+        module LearningRateMultiplier
+          extend OpenAI::Internal::Type::Union
+
+          def self?.variants: -> ::Array[OpenAI::Models::FineTuning::SupervisedHyperparameters::learning_rate_multiplier]
+        end
+
+        type n_epochs = :auto | Integer
+
+        module NEpochs
+          extend OpenAI::Internal::Type::Union
+
+          def self?.variants: -> ::Array[OpenAI::Models::FineTuning::SupervisedHyperparameters::n_epochs]
+        end
+      end
+    end
+  end
+end

data/sig/openai/models/fine_tuning/supervised_method.rbs

@@ -0,0 +1,24 @@
+module OpenAI
+  module Models
+    module FineTuning
+      type supervised_method =
+        { hyperparameters: OpenAI::FineTuning::SupervisedHyperparameters }
+
+      class SupervisedMethod < OpenAI::Internal::Type::BaseModel
+        attr_reader hyperparameters: OpenAI::FineTuning::SupervisedHyperparameters?
+
+        def hyperparameters=: (
+          OpenAI::FineTuning::SupervisedHyperparameters
+        ) -> OpenAI::FineTuning::SupervisedHyperparameters
+
+        def initialize: (
+          ?hyperparameters: OpenAI::FineTuning::SupervisedHyperparameters
+        ) -> void
+
+        def to_hash: -> {
+          hyperparameters: OpenAI::FineTuning::SupervisedHyperparameters
+        }
+      end
+    end
+  end
+end

data/sig/openai/models/function_definition.rbs

@@ -0,0 +1,41 @@
+module OpenAI
+  module Models
+    type function_definition =
+      {
+        name: String,
+        description: String,
+        parameters: OpenAI::Models::function_parameters,
+        strict: bool?
+      }
+
+    class FunctionDefinition < OpenAI::Internal::Type::BaseModel
+      attr_accessor name: String
+
+      attr_reader description: String?
+
+      def description=: (String) -> String
+
+      attr_reader parameters: OpenAI::Models::function_parameters?
+
+      def parameters=: (
+        OpenAI::Models::function_parameters
+      ) -> OpenAI::Models::function_parameters
+
+      attr_accessor strict: bool?
+
+      def initialize: (
+        name: String,
+        ?description: String,
+        ?parameters: OpenAI::Models::function_parameters,
+        ?strict: bool?
+      ) -> void
+
+      def to_hash: -> {
+        name: String,
+        description: String,
+        parameters: OpenAI::Models::function_parameters,
+        strict: bool?
+      }
+    end
+  end
+end

data/sig/openai/models/function_parameters.rbs

@@ -0,0 +1,7 @@
+module OpenAI
+  module Models
+    type function_parameters = ::Hash[Symbol, top]
+
+    FunctionParameters: OpenAI::Internal::Type::Converter
+  end
+end

data/sig/openai/models/graders/label_model_grader.rbs

@@ -0,0 +1,126 @@
+module OpenAI
+  module Models
+    class LabelModelGrader = Graders::LabelModelGrader
+
+    module Graders
+      type label_model_grader =
+        {
+          input: ::Array[OpenAI::Graders::LabelModelGrader::Input],
+          labels: ::Array[String],
+          model: String,
+          name: String,
+          passing_labels: ::Array[String],
+          type: :label_model
+        }
+
+      class LabelModelGrader < OpenAI::Internal::Type::BaseModel
+        attr_accessor input: ::Array[OpenAI::Graders::LabelModelGrader::Input]
+
+        attr_accessor labels: ::Array[String]
+
+        attr_accessor model: String
+
+        attr_accessor name: String
+
+        attr_accessor passing_labels: ::Array[String]
+
+        attr_accessor type: :label_model
+
+        def initialize: (
+          input: ::Array[OpenAI::Graders::LabelModelGrader::Input],
+          labels: ::Array[String],
+          model: String,
+          name: String,
+          passing_labels: ::Array[String],
+          ?type: :label_model
+        ) -> void
+
+        def to_hash: -> {
+          input: ::Array[OpenAI::Graders::LabelModelGrader::Input],
+          labels: ::Array[String],
+          model: String,
+          name: String,
+          passing_labels: ::Array[String],
+          type: :label_model
+        }
+
+        type input =
+          {
+            content: OpenAI::Models::Graders::LabelModelGrader::Input::content,
+            role: OpenAI::Models::Graders::LabelModelGrader::Input::role,
+            type: OpenAI::Models::Graders::LabelModelGrader::Input::type_
+          }
+
+        class Input < OpenAI::Internal::Type::BaseModel
+          attr_accessor content: OpenAI::Models::Graders::LabelModelGrader::Input::content
+
+          attr_accessor role: OpenAI::Models::Graders::LabelModelGrader::Input::role
+
+          attr_reader type: OpenAI::Models::Graders::LabelModelGrader::Input::type_?
+
+          def type=: (
+            OpenAI::Models::Graders::LabelModelGrader::Input::type_
+          ) -> OpenAI::Models::Graders::LabelModelGrader::Input::type_
+
+          def initialize: (
+            content: OpenAI::Models::Graders::LabelModelGrader::Input::content,
+            role: OpenAI::Models::Graders::LabelModelGrader::Input::role,
+            ?type: OpenAI::Models::Graders::LabelModelGrader::Input::type_
+          ) -> void
+
+          def to_hash: -> {
+            content: OpenAI::Models::Graders::LabelModelGrader::Input::content,
+            role: OpenAI::Models::Graders::LabelModelGrader::Input::role,
+            type: OpenAI::Models::Graders::LabelModelGrader::Input::type_
+          }
+
+          type content =
+            String
+            | OpenAI::Responses::ResponseInputText
+            | OpenAI::Graders::LabelModelGrader::Input::Content::OutputText
+
+          module Content
+            extend OpenAI::Internal::Type::Union
+
+            type output_text = { text: String, type: :output_text }
+
+            class OutputText < OpenAI::Internal::Type::BaseModel
+              attr_accessor text: String
+
+              attr_accessor type: :output_text
+
+              def initialize: (text: String, ?type: :output_text) -> void
+
+              def to_hash: -> { text: String, type: :output_text }
+            end
+
+            def self?.variants: -> ::Array[OpenAI::Models::Graders::LabelModelGrader::Input::content]
+          end
+
+          type role = :user | :assistant | :system | :developer
+
+          module Role
+            extend OpenAI::Internal::Type::Enum
+
+            USER: :user
+            ASSISTANT: :assistant
+            SYSTEM: :system
+            DEVELOPER: :developer
+
+            def self?.values: -> ::Array[OpenAI::Models::Graders::LabelModelGrader::Input::role]
+          end
+
+          type type_ = :message
+
+          module Type
+            extend OpenAI::Internal::Type::Enum
+
+            MESSAGE: :message
+
+            def self?.values: -> ::Array[OpenAI::Models::Graders::LabelModelGrader::Input::type_]
+          end
+        end
+      end
+    end
+  end
+end

data/sig/openai/models/graders/multi_grader.rbs

@@ -0,0 +1,52 @@
+module OpenAI
+  module Models
+    class MultiGrader = Graders::MultiGrader
+
+    module Graders
+      type multi_grader =
+        {
+          calculate_output: String,
+          graders: ::Hash[Symbol, OpenAI::Models::Graders::MultiGrader::grader],
+          name: String,
+          type: :multi
+        }
+
+      class MultiGrader < OpenAI::Internal::Type::BaseModel
+        attr_accessor calculate_output: String
+
+        attr_accessor graders: ::Hash[Symbol, OpenAI::Models::Graders::MultiGrader::grader]
+
+        attr_accessor name: String
+
+        attr_accessor type: :multi
+
+        def initialize: (
+          calculate_output: String,
+          graders: ::Hash[Symbol, OpenAI::Models::Graders::MultiGrader::grader],
+          name: String,
+          ?type: :multi
+        ) -> void
+
+        def to_hash: -> {
+          calculate_output: String,
+          graders: ::Hash[Symbol, OpenAI::Models::Graders::MultiGrader::grader],
+          name: String,
+          type: :multi
+        }
+
+        type grader =
+          OpenAI::Graders::StringCheckGrader
+          | OpenAI::Graders::TextSimilarityGrader
+          | OpenAI::Graders::PythonGrader
+          | OpenAI::Graders::ScoreModelGrader
+          | OpenAI::Graders::LabelModelGrader
+
+        module Grader
+          extend OpenAI::Internal::Type::Union
+
+          def self?.variants: -> ::Array[OpenAI::Models::Graders::MultiGrader::grader]
+        end
+      end
+    end
+  end
+end

data/sig/openai/models/graders/python_grader.rbs

@@ -0,0 +1,36 @@
+module OpenAI
+  module Models
+    class PythonGrader = Graders::PythonGrader
+
+    module Graders
+      type python_grader =
+        { name: String, source: String, type: :python, image_tag: String }
+
+      class PythonGrader < OpenAI::Internal::Type::BaseModel
+        attr_accessor name: String
+
+        attr_accessor source: String
+
+        attr_accessor type: :python
+
+        attr_reader image_tag: String?
+
+        def image_tag=: (String) -> String
+
+        def initialize: (
+          name: String,
+          source: String,
+          ?image_tag: String,
+          ?type: :python
+        ) -> void
+
+        def to_hash: -> {
+          name: String,
+          source: String,
+          type: :python,
+          image_tag: String
+        }
+      end
+    end
+  end
+end

data/sig/openai/models/graders/score_model_grader.rbs

@@ -0,0 +1,130 @@
+module OpenAI
+  module Models
+    class ScoreModelGrader = Graders::ScoreModelGrader
+
+    module Graders
+      type score_model_grader =
+        {
+          input: ::Array[OpenAI::Graders::ScoreModelGrader::Input],
+          model: String,
+          name: String,
+          type: :score_model,
+          range: ::Array[Float],
+          sampling_params: top
+        }
+
+      class ScoreModelGrader < OpenAI::Internal::Type::BaseModel
+        attr_accessor input: ::Array[OpenAI::Graders::ScoreModelGrader::Input]
+
+        attr_accessor model: String
+
+        attr_accessor name: String
+
+        attr_accessor type: :score_model
+
+        attr_reader range: ::Array[Float]?
+
+        def range=: (::Array[Float]) -> ::Array[Float]
+
+        attr_reader sampling_params: top?
+
+        def sampling_params=: (top) -> top
+
+        def initialize: (
+          input: ::Array[OpenAI::Graders::ScoreModelGrader::Input],
+          model: String,
+          name: String,
+          ?range: ::Array[Float],
+          ?sampling_params: top,
+          ?type: :score_model
+        ) -> void
+
+        def to_hash: -> {
+          input: ::Array[OpenAI::Graders::ScoreModelGrader::Input],
+          model: String,
+          name: String,
+          type: :score_model,
+          range: ::Array[Float],
+          sampling_params: top
+        }
+
+        type input =
+          {
+            content: OpenAI::Models::Graders::ScoreModelGrader::Input::content,
+            role: OpenAI::Models::Graders::ScoreModelGrader::Input::role,
+            type: OpenAI::Models::Graders::ScoreModelGrader::Input::type_
+          }
+
+        class Input < OpenAI::Internal::Type::BaseModel
+          attr_accessor content: OpenAI::Models::Graders::ScoreModelGrader::Input::content
+
+          attr_accessor role: OpenAI::Models::Graders::ScoreModelGrader::Input::role
+
+          attr_reader type: OpenAI::Models::Graders::ScoreModelGrader::Input::type_?
+
+          def type=: (
+            OpenAI::Models::Graders::ScoreModelGrader::Input::type_
+          ) -> OpenAI::Models::Graders::ScoreModelGrader::Input::type_
+
+          def initialize: (
+            content: OpenAI::Models::Graders::ScoreModelGrader::Input::content,
+            role: OpenAI::Models::Graders::ScoreModelGrader::Input::role,
+            ?type: OpenAI::Models::Graders::ScoreModelGrader::Input::type_
+          ) -> void
+
+          def to_hash: -> {
+            content: OpenAI::Models::Graders::ScoreModelGrader::Input::content,
+            role: OpenAI::Models::Graders::ScoreModelGrader::Input::role,
+            type: OpenAI::Models::Graders::ScoreModelGrader::Input::type_
+          }
+
+          type content =
+            String
+            | OpenAI::Responses::ResponseInputText
+            | OpenAI::Graders::ScoreModelGrader::Input::Content::OutputText
+
+          module Content
+            extend OpenAI::Internal::Type::Union
+
+            type output_text = { text: String, type: :output_text }
+
+            class OutputText < OpenAI::Internal::Type::BaseModel
+              attr_accessor text: String
+
+              attr_accessor type: :output_text
+
+              def initialize: (text: String, ?type: :output_text) -> void
+
+              def to_hash: -> { text: String, type: :output_text }
+            end
+
+            def self?.variants: -> ::Array[OpenAI::Models::Graders::ScoreModelGrader::Input::content]
+          end
+
+          type role = :user | :assistant | :system | :developer
+
+          module Role
+            extend OpenAI::Internal::Type::Enum
+
+            USER: :user
+            ASSISTANT: :assistant
+            SYSTEM: :system
+            DEVELOPER: :developer
+
+            def self?.values: -> ::Array[OpenAI::Models::Graders::ScoreModelGrader::Input::role]
+          end
+
+          type type_ = :message
+
+          module Type
+            extend OpenAI::Internal::Type::Enum
+
+            MESSAGE: :message
+
+            def self?.values: -> ::Array[OpenAI::Models::Graders::ScoreModelGrader::Input::type_]
+          end
+        end
+      end
+    end
+  end
+end

data/sig/openai/models/graders/string_check_grader.rbs

@@ -0,0 +1,57 @@
+module OpenAI
+  module Models
+    class StringCheckGrader = Graders::StringCheckGrader
+
+    module Graders
+      type string_check_grader =
+        {
+          input: String,
+          name: String,
+          operation: OpenAI::Models::Graders::StringCheckGrader::operation,
+          reference: String,
+          type: :string_check
+        }
+
+      class StringCheckGrader < OpenAI::Internal::Type::BaseModel
+        attr_accessor input: String
+
+        attr_accessor name: String
+
+        attr_accessor operation: OpenAI::Models::Graders::StringCheckGrader::operation
+
+        attr_accessor reference: String
+
+        attr_accessor type: :string_check
+
+        def initialize: (
+          input: String,
+          name: String,
+          operation: OpenAI::Models::Graders::StringCheckGrader::operation,
+          reference: String,
+          ?type: :string_check
+        ) -> void
+
+        def to_hash: -> {
+          input: String,
+          name: String,
+          operation: OpenAI::Models::Graders::StringCheckGrader::operation,
+          reference: String,
+          type: :string_check
+        }
+
+        type operation = :eq | :ne | :like | :ilike
+
+        module Operation
+          extend OpenAI::Internal::Type::Enum
+
+          EQ: :eq
+          NE: :ne
+          LIKE: :like
+          ILIKE: :ilike
+
+          def self?.values: -> ::Array[OpenAI::Models::Graders::StringCheckGrader::operation]
+        end
+      end
+    end
+  end
+end

data/sig/openai/models/graders/text_similarity_grader.rbs

@@ -0,0 +1,73 @@
+module OpenAI
+  module Models
+    class TextSimilarityGrader = Graders::TextSimilarityGrader
+
+    module Graders
+      type text_similarity_grader =
+        {
+          evaluation_metric: OpenAI::Models::Graders::TextSimilarityGrader::evaluation_metric,
+          input: String,
+          name: String,
+          reference: String,
+          type: :text_similarity
+        }
+
+      class TextSimilarityGrader < OpenAI::Internal::Type::BaseModel
+        attr_accessor evaluation_metric: OpenAI::Models::Graders::TextSimilarityGrader::evaluation_metric
+
+        attr_accessor input: String
+
+        attr_accessor name: String
+
+        attr_accessor reference: String
+
+        attr_accessor type: :text_similarity
+
+        def initialize: (
+          evaluation_metric: OpenAI::Models::Graders::TextSimilarityGrader::evaluation_metric,
+          input: String,
+          name: String,
+          reference: String,
+          ?type: :text_similarity
+        ) -> void
+
+        def to_hash: -> {
+          evaluation_metric: OpenAI::Models::Graders::TextSimilarityGrader::evaluation_metric,
+          input: String,
+          name: String,
+          reference: String,
+          type: :text_similarity
+        }
+
+        type evaluation_metric =
+          :fuzzy_match
+          | :bleu
+          | :gleu
+          | :meteor
+          | :rouge_1
+          | :rouge_2
+          | :rouge_3
+          | :rouge_4
+          | :rouge_5
+          | :rouge_l
+
+        module EvaluationMetric
+          extend OpenAI::Internal::Type::Enum
+
+          FUZZY_MATCH: :fuzzy_match
+          BLEU: :bleu
+          GLEU: :gleu
+          METEOR: :meteor
+          ROUGE_1: :rouge_1
+          ROUGE_2: :rouge_2
+          ROUGE_3: :rouge_3
+          ROUGE_4: :rouge_4
+          ROUGE_5: :rouge_5
+          ROUGE_L: :rouge_l
+
+          def self?.values: -> ::Array[OpenAI::Models::Graders::TextSimilarityGrader::evaluation_metric]
+        end
+      end
+    end
+  end
+end

data/sig/openai/models/image.rbs

@@ -0,0 +1,31 @@
+module OpenAI
+  module Models
+    type image = { :b64_json => String, revised_prompt: String, url: String }
+
+    class Image < OpenAI::Internal::Type::BaseModel
+      attr_reader b64_json: String?
+
+      def b64_json=: (String) -> String
+
+      attr_reader revised_prompt: String?
+
+      def revised_prompt=: (String) -> String
+
+      attr_reader url: String?
+
+      def url=: (String) -> String
+
+      def initialize: (
+        ?b64_json: String,
+        ?revised_prompt: String,
+        ?url: String
+      ) -> void
+
+      def to_hash: -> {
+        :b64_json => String,
+        revised_prompt: String,
+        url: String
+      }
+    end
+  end
+end