openai 0.1.0.pre.beta.2

data/lib/openai/models/graders/python_grader.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Graders
+      class PythonGrader < OpenAI::Internal::Type::BaseModel
+        # @!attribute name
+        #   The name of the grader.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute source
+        #   The source code of the python script.
+        #
+        #   @return [String]
+        required :source, String
+
+        # @!attribute type
+        #   The object type, which is always `python`.
+        #
+        #   @return [Symbol, :python]
+        required :type, const: :python
+
+        # @!attribute image_tag
+        #   The image tag to use for the python script.
+        #
+        #   @return [String, nil]
+        optional :image_tag, String
+
+        # @!method initialize(name:, source:, image_tag: nil, type: :python)
+        #   A PythonGrader object that runs a python script on the input.
+        #
+        #   @param name [String] The name of the grader.
+        #
+        #   @param source [String] The source code of the python script.
+        #
+        #   @param image_tag [String] The image tag to use for the python script.
+        #
+        #   @param type [Symbol, :python] The object type, which is always `python`.
+      end
+    end
+
+    PythonGrader = Graders::PythonGrader
+  end
+end

data/lib/openai/models/graders/score_model_grader.rb

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Graders
+      class ScoreModelGrader < OpenAI::Internal::Type::BaseModel
+        # @!attribute input
+        #   The input text. This may include template strings.
+        #
+        #   @return [Array<OpenAI::Models::Graders::ScoreModelGrader::Input>]
+        required :input, -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Graders::ScoreModelGrader::Input] }
+
+        # @!attribute model
+        #   The model to use for the evaluation.
+        #
+        #   @return [String]
+        required :model, String
+
+        # @!attribute name
+        #   The name of the grader.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute type
+        #   The object type, which is always `score_model`.
+        #
+        #   @return [Symbol, :score_model]
+        required :type, const: :score_model
+
+        # @!attribute range
+        #   The range of the score. Defaults to `[0, 1]`.
+        #
+        #   @return [Array<Float>, nil]
+        optional :range, OpenAI::Internal::Type::ArrayOf[Float]
+
+        # @!attribute sampling_params
+        #   The sampling parameters for the model.
+        #
+        #   @return [Object, nil]
+        optional :sampling_params, OpenAI::Internal::Type::Unknown
+
+        # @!method initialize(input:, model:, name:, range: nil, sampling_params: nil, type: :score_model)
+        #   A ScoreModelGrader object that uses a model to assign a score to the input.
+        #
+        #   @param input [Array<OpenAI::Models::Graders::ScoreModelGrader::Input>] The input text. This may include template strings.
+        #
+        #   @param model [String] The model to use for the evaluation.
+        #
+        #   @param name [String] The name of the grader.
+        #
+        #   @param range [Array<Float>] The range of the score. Defaults to `[0, 1]`.
+        #
+        #   @param sampling_params [Object] The sampling parameters for the model.
+        #
+        #   @param type [Symbol, :score_model] The object type, which is always `score_model`.
+
+        class Input < OpenAI::Internal::Type::BaseModel
+          # @!attribute content
+          #   Text inputs to the model - can contain template strings.
+          #
+          #   @return [String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Graders::ScoreModelGrader::Input::Content::OutputText]
+          required :content, union: -> { OpenAI::Graders::ScoreModelGrader::Input::Content }
+
+          # @!attribute role
+          #   The role of the message input. One of `user`, `assistant`, `system`, or
+          #   `developer`.
+          #
+          #   @return [Symbol, OpenAI::Models::Graders::ScoreModelGrader::Input::Role]
+          required :role, enum: -> { OpenAI::Graders::ScoreModelGrader::Input::Role }
+
+          # @!attribute type
+          #   The type of the message input. Always `message`.
+          #
+          #   @return [Symbol, OpenAI::Models::Graders::ScoreModelGrader::Input::Type, nil]
+          optional :type, enum: -> { OpenAI::Graders::ScoreModelGrader::Input::Type }
+
+          # @!method initialize(content:, role:, type: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Graders::ScoreModelGrader::Input} for more details.
+          #
+          #   A message input to the model with a role indicating instruction following
+          #   hierarchy. Instructions given with the `developer` or `system` role take
+          #   precedence over instructions given with the `user` role. Messages with the
+          #   `assistant` role are presumed to have been generated by the model in previous
+          #   interactions.
+          #
+          #   @param content [String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Graders::ScoreModelGrader::Input::Content::OutputText] Text inputs to the model - can contain template strings.
+          #
+          #   @param role [Symbol, OpenAI::Models::Graders::ScoreModelGrader::Input::Role] The role of the message input. One of `user`, `assistant`, `system`, or
+          #
+          #   @param type [Symbol, OpenAI::Models::Graders::ScoreModelGrader::Input::Type] The type of the message input. Always `message`.
+
+          # Text inputs to the model - can contain template strings.
+          #
+          # @see OpenAI::Models::Graders::ScoreModelGrader::Input#content
+          module Content
+            extend OpenAI::Internal::Type::Union
+
+            # A text input to the model.
+            variant String
+
+            # A text input to the model.
+            variant -> { OpenAI::Responses::ResponseInputText }
+
+            # A text output from the model.
+            variant -> { OpenAI::Graders::ScoreModelGrader::Input::Content::OutputText }
+
+            class OutputText < OpenAI::Internal::Type::BaseModel
+              # @!attribute text
+              #   The text output from the model.
+              #
+              #   @return [String]
+              required :text, String
+
+              # @!attribute type
+              #   The type of the output text. Always `output_text`.
+              #
+              #   @return [Symbol, :output_text]
+              required :type, const: :output_text
+
+              # @!method initialize(text:, type: :output_text)
+              #   Some parameter documentations has been truncated, see
+              #   {OpenAI::Models::Graders::ScoreModelGrader::Input::Content::OutputText} for more
+              #   details.
+              #
+              #   A text output from the model.
+              #
+              #   @param text [String] The text output from the model.
+              #
+              #   @param type [Symbol, :output_text] The type of the output text. Always `output_text`.
+            end
+
+            # @!method self.variants
+            #   @return [Array(String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Graders::ScoreModelGrader::Input::Content::OutputText)]
+          end
+
+          # The role of the message input. One of `user`, `assistant`, `system`, or
+          # `developer`.
+          #
+          # @see OpenAI::Models::Graders::ScoreModelGrader::Input#role
+          module Role
+            extend OpenAI::Internal::Type::Enum
+
+            USER = :user
+            ASSISTANT = :assistant
+            SYSTEM = :system
+            DEVELOPER = :developer
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # The type of the message input. Always `message`.
+          #
+          # @see OpenAI::Models::Graders::ScoreModelGrader::Input#type
+          module Type
+            extend OpenAI::Internal::Type::Enum
+
+            MESSAGE = :message
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+
+    ScoreModelGrader = Graders::ScoreModelGrader
+  end
+end

data/lib/openai/models/graders/string_check_grader.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Graders
+      class StringCheckGrader < OpenAI::Internal::Type::BaseModel
+        # @!attribute input
+        #   The input text. This may include template strings.
+        #
+        #   @return [String]
+        required :input, String
+
+        # @!attribute name
+        #   The name of the grader.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute operation
+        #   The string check operation to perform. One of `eq`, `ne`, `like`, or `ilike`.
+        #
+        #   @return [Symbol, OpenAI::Models::Graders::StringCheckGrader::Operation]
+        required :operation, enum: -> { OpenAI::Graders::StringCheckGrader::Operation }
+
+        # @!attribute reference
+        #   The reference text. This may include template strings.
+        #
+        #   @return [String]
+        required :reference, String
+
+        # @!attribute type
+        #   The object type, which is always `string_check`.
+        #
+        #   @return [Symbol, :string_check]
+        required :type, const: :string_check
+
+        # @!method initialize(input:, name:, operation:, reference:, type: :string_check)
+        #   A StringCheckGrader object that performs a string comparison between input and
+        #   reference using a specified operation.
+        #
+        #   @param input [String] The input text. This may include template strings.
+        #
+        #   @param name [String] The name of the grader.
+        #
+        #   @param operation [Symbol, OpenAI::Models::Graders::StringCheckGrader::Operation] The string check operation to perform. One of `eq`, `ne`, `like`, or `ilike`.
+        #
+        #   @param reference [String] The reference text. This may include template strings.
+        #
+        #   @param type [Symbol, :string_check] The object type, which is always `string_check`.
+
+        # The string check operation to perform. One of `eq`, `ne`, `like`, or `ilike`.
+        #
+        # @see OpenAI::Models::Graders::StringCheckGrader#operation
+        module Operation
+          extend OpenAI::Internal::Type::Enum
+
+          EQ = :eq
+          NE = :ne
+          LIKE = :like
+          ILIKE = :ilike
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+
+    StringCheckGrader = Graders::StringCheckGrader
+  end
+end

data/lib/openai/models/graders/text_similarity_grader.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Graders
+      class TextSimilarityGrader < OpenAI::Internal::Type::BaseModel
+        # @!attribute evaluation_metric
+        #   The evaluation metric to use. One of `fuzzy_match`, `bleu`, `gleu`, `meteor`,
+        #   `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, or `rouge_l`.
+        #
+        #   @return [Symbol, OpenAI::Models::Graders::TextSimilarityGrader::EvaluationMetric]
+        required :evaluation_metric, enum: -> { OpenAI::Graders::TextSimilarityGrader::EvaluationMetric }
+
+        # @!attribute input
+        #   The text being graded.
+        #
+        #   @return [String]
+        required :input, String
+
+        # @!attribute name
+        #   The name of the grader.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute reference
+        #   The text being graded against.
+        #
+        #   @return [String]
+        required :reference, String
+
+        # @!attribute type
+        #   The type of grader.
+        #
+        #   @return [Symbol, :text_similarity]
+        required :type, const: :text_similarity
+
+        # @!method initialize(evaluation_metric:, input:, name:, reference:, type: :text_similarity)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Graders::TextSimilarityGrader} for more details.
+        #
+        #   A TextSimilarityGrader object which grades text based on similarity metrics.
+        #
+        #   @param evaluation_metric [Symbol, OpenAI::Models::Graders::TextSimilarityGrader::EvaluationMetric] The evaluation metric to use. One of `fuzzy_match`, `bleu`, `gleu`, `meteor`, `r
+        #
+        #   @param input [String] The text being graded.
+        #
+        #   @param name [String] The name of the grader.
+        #
+        #   @param reference [String] The text being graded against.
+        #
+        #   @param type [Symbol, :text_similarity] The type of grader.
+
+        # The evaluation metric to use. One of `fuzzy_match`, `bleu`, `gleu`, `meteor`,
+        # `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, or `rouge_l`.
+        #
+        # @see OpenAI::Models::Graders::TextSimilarityGrader#evaluation_metric
+        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
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+
+    TextSimilarityGrader = Graders::TextSimilarityGrader
+  end
+end

data/lib/openai/models/image.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    class Image < OpenAI::Internal::Type::BaseModel
+      # @!attribute b64_json
+      #   The base64-encoded JSON of the generated image. Default value for `gpt-image-1`,
+      #   and only present if `response_format` is set to `b64_json` for `dall-e-2` and
+      #   `dall-e-3`.
+      #
+      #   @return [String, nil]
+      optional :b64_json, String
+
+      # @!attribute revised_prompt
+      #   For `dall-e-3` only, the revised prompt that was used to generate the image.
+      #
+      #   @return [String, nil]
+      optional :revised_prompt, String
+
+      # @!attribute url
+      #   When using `dall-e-2` or `dall-e-3`, the URL of the generated image if
+      #   `response_format` is set to `url` (default value). Unsupported for
+      #   `gpt-image-1`.
+      #
+      #   @return [String, nil]
+      optional :url, String
+
+      # @!method initialize(b64_json: nil, revised_prompt: nil, url: nil)
+      #   Some parameter documentations has been truncated, see {OpenAI::Models::Image}
+      #   for more details.
+      #
+      #   Represents the content or the URL of an image generated by the OpenAI API.
+      #
+      #   @param b64_json [String] The base64-encoded JSON of the generated image. Default value for `gpt-image-1`,
+      #
+      #   @param revised_prompt [String] For `dall-e-3` only, the revised prompt that was used to generate the image.
+      #
+      #   @param url [String] When using `dall-e-2` or `dall-e-3`, the URL of the generated image if `response
+    end
+  end
+end

data/lib/openai/models/image_create_variation_params.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    # @see OpenAI::Resources::Images#create_variation
+    class ImageCreateVariationParams < OpenAI::Internal::Type::BaseModel
+      extend OpenAI::Internal::Type::RequestParameters::Converter
+      include OpenAI::Internal::Type::RequestParameters
+
+      # @!attribute image
+      #   The image to use as the basis for the variation(s). Must be a valid PNG file,
+      #   less than 4MB, and square.
+      #
+      #   @return [Pathname, StringIO, IO, String, OpenAI::FilePart]
+      required :image, OpenAI::Internal::Type::FileInput
+
+      # @!attribute model
+      #   The model to use for image generation. Only `dall-e-2` is supported at this
+      #   time.
+      #
+      #   @return [String, Symbol, OpenAI::Models::ImageModel, nil]
+      optional :model, union: -> { OpenAI::ImageCreateVariationParams::Model }, nil?: true
+
+      # @!attribute n
+      #   The number of images to generate. Must be between 1 and 10.
+      #
+      #   @return [Integer, nil]
+      optional :n, Integer, nil?: true
+
+      # @!attribute response_format
+      #   The format in which the generated images are returned. Must be one of `url` or
+      #   `b64_json`. URLs are only valid for 60 minutes after the image has been
+      #   generated.
+      #
+      #   @return [Symbol, OpenAI::Models::ImageCreateVariationParams::ResponseFormat, nil]
+      optional :response_format, enum: -> { OpenAI::ImageCreateVariationParams::ResponseFormat }, nil?: true
+
+      # @!attribute size
+      #   The size of the generated images. Must be one of `256x256`, `512x512`, or
+      #   `1024x1024`.
+      #
+      #   @return [Symbol, OpenAI::Models::ImageCreateVariationParams::Size, nil]
+      optional :size, enum: -> { OpenAI::ImageCreateVariationParams::Size }, nil?: true
+
+      # @!attribute user
+      #   A unique identifier representing your end-user, which can help OpenAI to monitor
+      #   and detect abuse.
+      #   [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids).
+      #
+      #   @return [String, nil]
+      optional :user, String
+
+      # @!method initialize(image:, model: nil, n: nil, response_format: nil, size: nil, user: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {OpenAI::Models::ImageCreateVariationParams} for more details.
+      #
+      #   @param image [Pathname, StringIO, IO, String, OpenAI::FilePart] The image to use as the basis for the variation(s). Must be a valid PNG file, le
+      #
+      #   @param model [String, Symbol, OpenAI::Models::ImageModel, nil] The model to use for image generation. Only `dall-e-2` is supported at this time
+      #
+      #   @param n [Integer, nil] The number of images to generate. Must be between 1 and 10.
+      #
+      #   @param response_format [Symbol, OpenAI::Models::ImageCreateVariationParams::ResponseFormat, nil] The format in which the generated images are returned. Must be one of `url` or `
+      #
+      #   @param size [Symbol, OpenAI::Models::ImageCreateVariationParams::Size, nil] The size of the generated images. Must be one of `256x256`, `512x512`, or `1024x
+      #
+      #   @param user [String] A unique identifier representing your end-user, which can help OpenAI to monitor
+      #
+      #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+
+      # The model to use for image generation. Only `dall-e-2` is supported at this
+      # time.
+      module Model
+        extend OpenAI::Internal::Type::Union
+
+        variant String
+
+        # The model to use for image generation. Only `dall-e-2` is supported at this time.
+        variant enum: -> { OpenAI::ImageModel }
+
+        # @!method self.variants
+        #   @return [Array(String, Symbol, OpenAI::Models::ImageModel)]
+      end
+
+      # The format in which the generated images are returned. Must be one of `url` or
+      # `b64_json`. URLs are only valid for 60 minutes after the image has been
+      # generated.
+      module ResponseFormat
+        extend OpenAI::Internal::Type::Enum
+
+        URL = :url
+        B64_JSON = :b64_json
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The size of the generated images. Must be one of `256x256`, `512x512`, or
+      # `1024x1024`.
+      module Size
+        extend OpenAI::Internal::Type::Enum
+
+        SIZE_256X256 = :"256x256"
+        SIZE_512X512 = :"512x512"
+        SIZE_1024X1024 = :"1024x1024"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end