openai 0.1.0.pre.beta.2 → 0.1.0

data/lib/openai/models/moderation_create_params.rb

@@ -1,80 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    # @see OpenAI::Resources::Moderations#create
-    class ModerationCreateParams < OpenAI::Internal::Type::BaseModel
-      extend OpenAI::Internal::Type::RequestParameters::Converter
-      include OpenAI::Internal::Type::RequestParameters
-
-      # @!attribute input
-      #   Input (or inputs) to classify. Can be a single string, an array of strings, or
-      #   an array of multi-modal input objects similar to other models.
-      #
-      #   @return [String, Array<String>, Array<OpenAI::Models::ModerationImageURLInput, OpenAI::Models::ModerationTextInput>]
-      required :input, union: -> { OpenAI::ModerationCreateParams::Input }
-
-      # @!attribute model
-      #   The content moderation model you would like to use. Learn more in
-      #   [the moderation guide](https://platform.openai.com/docs/guides/moderation), and
-      #   learn about available models
-      #   [here](https://platform.openai.com/docs/models#moderation).
-      #
-      #   @return [String, Symbol, OpenAI::Models::ModerationModel, nil]
-      optional :model, union: -> { OpenAI::ModerationCreateParams::Model }
-
-      # @!method initialize(input:, model: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {OpenAI::Models::ModerationCreateParams} for more details.
-      #
-      #   @param input [String, Array<String>, Array<OpenAI::Models::ModerationImageURLInput, OpenAI::Models::ModerationTextInput>] Input (or inputs) to classify. Can be a single string, an array of strings, or
-      #
-      #   @param model [String, Symbol, OpenAI::Models::ModerationModel] The content moderation model you would like to use. Learn more in
-      #
-      #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
-
-      # Input (or inputs) to classify. Can be a single string, an array of strings, or
-      # an array of multi-modal input objects similar to other models.
-      module Input
-        extend OpenAI::Internal::Type::Union
-
-        # A string of text to classify for moderation.
-        variant String
-
-        # An array of strings to classify for moderation.
-        variant -> { OpenAI::Models::ModerationCreateParams::Input::StringArray }
-
-        # An array of multi-modal inputs to the moderation model.
-        variant -> { OpenAI::Models::ModerationCreateParams::Input::ModerationMultiModalInputArray }
-
-        # @!method self.variants
-        #   @return [Array(String, Array<String>, Array<OpenAI::Models::ModerationImageURLInput, OpenAI::Models::ModerationTextInput>)]
-
-        # @type [OpenAI::Internal::Type::Converter]
-        StringArray = OpenAI::Internal::Type::ArrayOf[String]
-
-        # @type [OpenAI::Internal::Type::Converter]
-        ModerationMultiModalInputArray =
-          OpenAI::Internal::Type::ArrayOf[union: -> { OpenAI::ModerationMultiModalInput }]
-      end
-
-      # The content moderation model you would like to use. Learn more in
-      # [the moderation guide](https://platform.openai.com/docs/guides/moderation), and
-      # learn about available models
-      # [here](https://platform.openai.com/docs/models#moderation).
-      module Model
-        extend OpenAI::Internal::Type::Union
-
-        variant String
-
-        # The content moderation model you would like to use. Learn more in
-        # [the moderation guide](https://platform.openai.com/docs/guides/moderation), and learn about
-        # available models [here](https://platform.openai.com/docs/models#moderation).
-        variant enum: -> { OpenAI::ModerationModel }
-
-        # @!method self.variants
-        #   @return [Array(String, Symbol, OpenAI::Models::ModerationModel)]
-      end
-    end
-  end
-end

data/lib/openai/models/moderation_create_response.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    # @see OpenAI::Resources::Moderations#create
-    class ModerationCreateResponse < OpenAI::Internal::Type::BaseModel
-      # @!attribute id
-      #   The unique identifier for the moderation request.
-      #
-      #   @return [String]
-      required :id, String
-
-      # @!attribute model
-      #   The model used to generate the moderation results.
-      #
-      #   @return [String]
-      required :model, String
-
-      # @!attribute results
-      #   A list of moderation objects.
-      #
-      #   @return [Array<OpenAI::Models::Moderation>]
-      required :results, -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Moderation] }
-
-      # @!method initialize(id:, model:, results:)
-      #   Represents if a given text input is potentially harmful.
-      #
-      #   @param id [String] The unique identifier for the moderation request.
-      #
-      #   @param model [String] The model used to generate the moderation results.
-      #
-      #   @param results [Array<OpenAI::Models::Moderation>] A list of moderation objects.
-    end
-  end
-end

data/lib/openai/models/moderation_image_url_input.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    class ModerationImageURLInput < OpenAI::Internal::Type::BaseModel
-      # @!attribute image_url
-      #   Contains either an image URL or a data URL for a base64 encoded image.
-      #
-      #   @return [OpenAI::Models::ModerationImageURLInput::ImageURL]
-      required :image_url, -> { OpenAI::ModerationImageURLInput::ImageURL }
-
-      # @!attribute type
-      #   Always `image_url`.
-      #
-      #   @return [Symbol, :image_url]
-      required :type, const: :image_url
-
-      # @!method initialize(image_url:, type: :image_url)
-      #   An object describing an image to classify.
-      #
-      #   @param image_url [OpenAI::Models::ModerationImageURLInput::ImageURL] Contains either an image URL or a data URL for a base64 encoded image.
-      #
-      #   @param type [Symbol, :image_url] Always `image_url`.
-
-      # @see OpenAI::Models::ModerationImageURLInput#image_url
-      class ImageURL < OpenAI::Internal::Type::BaseModel
-        # @!attribute url
-        #   Either a URL of the image or the base64 encoded image data.
-        #
-        #   @return [String]
-        required :url, String
-
-        # @!method initialize(url:)
-        #   Contains either an image URL or a data URL for a base64 encoded image.
-        #
-        #   @param url [String] Either a URL of the image or the base64 encoded image data.
-      end
-    end
-  end
-end

data/lib/openai/models/moderation_model.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module ModerationModel
-      extend OpenAI::Internal::Type::Enum
-
-      OMNI_MODERATION_LATEST = :"omni-moderation-latest"
-      OMNI_MODERATION_2024_09_26 = :"omni-moderation-2024-09-26"
-      TEXT_MODERATION_LATEST = :"text-moderation-latest"
-      TEXT_MODERATION_STABLE = :"text-moderation-stable"
-
-      # @!method self.values
-      #   @return [Array<Symbol>]
-    end
-  end
-end

data/lib/openai/models/moderation_multi_modal_input.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    # An object describing an image to classify.
-    module ModerationMultiModalInput
-      extend OpenAI::Internal::Type::Union
-
-      discriminator :type
-
-      # An object describing an image to classify.
-      variant :image_url, -> { OpenAI::ModerationImageURLInput }
-
-      # An object describing text to classify.
-      variant :text, -> { OpenAI::ModerationTextInput }
-
-      # @!method self.variants
-      #   @return [Array(OpenAI::Models::ModerationImageURLInput, OpenAI::Models::ModerationTextInput)]
-    end
-  end
-end

data/lib/openai/models/moderation_text_input.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    class ModerationTextInput < OpenAI::Internal::Type::BaseModel
-      # @!attribute text
-      #   A string of text to classify.
-      #
-      #   @return [String]
-      required :text, String
-
-      # @!attribute type
-      #   Always `text`.
-      #
-      #   @return [Symbol, :text]
-      required :type, const: :text
-
-      # @!method initialize(text:, type: :text)
-      #   An object describing text to classify.
-      #
-      #   @param text [String] A string of text to classify.
-      #
-      #   @param type [Symbol, :text] Always `text`.
-    end
-  end
-end

data/lib/openai/models/other_file_chunking_strategy_object.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    class OtherFileChunkingStrategyObject < OpenAI::Internal::Type::BaseModel
-      # @!attribute type
-      #   Always `other`.
-      #
-      #   @return [Symbol, :other]
-      required :type, const: :other
-
-      # @!method initialize(type: :other)
-      #   This is returned when the chunking strategy is unknown. Typically, this is
-      #   because the file was indexed before the `chunking_strategy` concept was
-      #   introduced in the API.
-      #
-      #   @param type [Symbol, :other] Always `other`.
-    end
-  end
-end

data/lib/openai/models/reasoning.rb

@@ -1,89 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    class Reasoning < OpenAI::Internal::Type::BaseModel
-      # @!attribute effort
-      #   **o-series models only**
-      #
-      #   Constrains effort on reasoning for
-      #   [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently
-      #   supported values are `low`, `medium`, and `high`. Reducing reasoning effort can
-      #   result in faster responses and fewer tokens used on reasoning in a response.
-      #
-      #   @return [Symbol, OpenAI::Models::ReasoningEffort, nil]
-      optional :effort, enum: -> { OpenAI::ReasoningEffort }, nil?: true
-
-      # @!attribute generate_summary
-      #   @deprecated
-      #
-      #   **Deprecated:** use `summary` instead.
-      #
-      #   A summary of the reasoning performed by the model. This can be useful for
-      #   debugging and understanding the model's reasoning process. One of `auto`,
-      #   `concise`, or `detailed`.
-      #
-      #   @return [Symbol, OpenAI::Models::Reasoning::GenerateSummary, nil]
-      optional :generate_summary, enum: -> { OpenAI::Reasoning::GenerateSummary }, nil?: true
-
-      # @!attribute summary
-      #   A summary of the reasoning performed by the model. This can be useful for
-      #   debugging and understanding the model's reasoning process. One of `auto`,
-      #   `concise`, or `detailed`.
-      #
-      #   @return [Symbol, OpenAI::Models::Reasoning::Summary, nil]
-      optional :summary, enum: -> { OpenAI::Reasoning::Summary }, nil?: true
-
-      # @!method initialize(effort: nil, generate_summary: nil, summary: nil)
-      #   Some parameter documentations has been truncated, see
-      #   {OpenAI::Models::Reasoning} for more details.
-      #
-      #   **o-series models only**
-      #
-      #   Configuration options for
-      #   [reasoning models](https://platform.openai.com/docs/guides/reasoning).
-      #
-      #   @param effort [Symbol, OpenAI::Models::ReasoningEffort, nil] **o-series models only**
-      #
-      #   @param generate_summary [Symbol, OpenAI::Models::Reasoning::GenerateSummary, nil] **Deprecated:** use `summary` instead.
-      #
-      #   @param summary [Symbol, OpenAI::Models::Reasoning::Summary, nil] A summary of the reasoning performed by the model. This can be
-
-      # @deprecated
-      #
-      # **Deprecated:** use `summary` instead.
-      #
-      # A summary of the reasoning performed by the model. This can be useful for
-      # debugging and understanding the model's reasoning process. One of `auto`,
-      # `concise`, or `detailed`.
-      #
-      # @see OpenAI::Models::Reasoning#generate_summary
-      module GenerateSummary
-        extend OpenAI::Internal::Type::Enum
-
-        AUTO = :auto
-        CONCISE = :concise
-        DETAILED = :detailed
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
-      # A summary of the reasoning performed by the model. This can be useful for
-      # debugging and understanding the model's reasoning process. One of `auto`,
-      # `concise`, or `detailed`.
-      #
-      # @see OpenAI::Models::Reasoning#summary
-      module Summary
-        extend OpenAI::Internal::Type::Enum
-
-        AUTO = :auto
-        CONCISE = :concise
-        DETAILED = :detailed
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-    end
-  end
-end

data/lib/openai/models/reasoning_effort.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    # **o-series models only**
-    #
-    # Constrains effort on reasoning for
-    # [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently
-    # supported values are `low`, `medium`, and `high`. Reducing reasoning effort can
-    # result in faster responses and fewer tokens used on reasoning in a response.
-    module ReasoningEffort
-      extend OpenAI::Internal::Type::Enum
-
-      LOW = :low
-      MEDIUM = :medium
-      HIGH = :high
-
-      # @!method self.values
-      #   @return [Array<Symbol>]
-    end
-  end
-end

data/lib/openai/models/response_format_json_object.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    class ResponseFormatJSONObject < OpenAI::Internal::Type::BaseModel
-      # @!attribute type
-      #   The type of response format being defined. Always `json_object`.
-      #
-      #   @return [Symbol, :json_object]
-      required :type, const: :json_object
-
-      # @!method initialize(type: :json_object)
-      #   JSON object response format. An older method of generating JSON responses. Using
-      #   `json_schema` is recommended for models that support it. Note that the model
-      #   will not generate JSON without a system or user message instructing it to do so.
-      #
-      #   @param type [Symbol, :json_object] The type of response format being defined. Always `json_object`.
-    end
-  end
-end

data/lib/openai/models/response_format_json_schema.rb

@@ -1,85 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    class ResponseFormatJSONSchema < OpenAI::Internal::Type::BaseModel
-      # @!attribute json_schema
-      #   Structured Outputs configuration options, including a JSON Schema.
-      #
-      #   @return [OpenAI::Models::ResponseFormatJSONSchema::JSONSchema]
-      required :json_schema, -> { OpenAI::ResponseFormatJSONSchema::JSONSchema }
-
-      # @!attribute type
-      #   The type of response format being defined. Always `json_schema`.
-      #
-      #   @return [Symbol, :json_schema]
-      required :type, const: :json_schema
-
-      # @!method initialize(json_schema:, type: :json_schema)
-      #   Some parameter documentations has been truncated, see
-      #   {OpenAI::Models::ResponseFormatJSONSchema} for more details.
-      #
-      #   JSON Schema response format. Used to generate structured JSON responses. Learn
-      #   more about
-      #   [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs).
-      #
-      #   @param json_schema [OpenAI::Models::ResponseFormatJSONSchema::JSONSchema] Structured Outputs configuration options, including a JSON Schema.
-      #
-      #   @param type [Symbol, :json_schema] The type of response format being defined. Always `json_schema`.
-
-      # @see OpenAI::Models::ResponseFormatJSONSchema#json_schema
-      class JSONSchema < OpenAI::Internal::Type::BaseModel
-        # @!attribute name
-        #   The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores
-        #   and dashes, with a maximum length of 64.
-        #
-        #   @return [String]
-        required :name, String
-
-        # @!attribute description
-        #   A description of what the response format is for, used by the model to determine
-        #   how to respond in the format.
-        #
-        #   @return [String, nil]
-        optional :description, String
-
-        # @!attribute schema
-        #   The schema for the response format, described as a JSON Schema object. Learn how
-        #   to build JSON schemas [here](https://json-schema.org/).
-        #
-        #   @return [Hash{Symbol=>Object}, nil]
-        optional :schema,
-                 union: -> {
-                   OpenAI::StructuredOutput::UnionOf[
-                     OpenAI::Internal::Type::HashOf[OpenAI::Internal::Type::Unknown],
-                     OpenAI::StructuredOutput::JsonSchemaConverter
-                   ]
-                 }
-
-        # @!attribute strict
-        #   Whether to enable strict schema adherence when generating the output. If set to
-        #   true, the model will always follow the exact schema defined in the `schema`
-        #   field. Only a subset of JSON Schema is supported when `strict` is `true`. To
-        #   learn more, read the
-        #   [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).
-        #
-        #   @return [Boolean, nil]
-        optional :strict, OpenAI::Internal::Type::Boolean, nil?: true
-
-        # @!method initialize(name:, description: nil, schema: nil, strict: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::ResponseFormatJSONSchema::JSONSchema} for more details.
-        #
-        #   Structured Outputs configuration options, including a JSON Schema.
-        #
-        #   @param name [String] The name of the response format. Must be a-z, A-Z, 0-9, or contain
-        #
-        #   @param description [String] A description of what the response format is for, used by the model to
-        #
-        #   @param schema [Hash{Symbol=>Object}, OpenAI::StructuredOutput::JsonSchemaConverter] The schema for the response format, described as a JSON Schema object.
-        #
-        #   @param strict [Boolean, nil] Whether to enable strict schema adherence when generating the output.
-      end
-    end
-  end
-end

data/lib/openai/models/response_format_text.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    class ResponseFormatText < OpenAI::Internal::Type::BaseModel
-      # @!attribute type
-      #   The type of response format being defined. Always `text`.
-      #
-      #   @return [Symbol, :text]
-      required :type, const: :text
-
-      # @!method initialize(type: :text)
-      #   Default response format. Used to generate text responses.
-      #
-      #   @param type [Symbol, :text] The type of response format being defined. Always `text`.
-    end
-  end
-end

data/lib/openai/models/responses/computer_tool.rb

@@ -1,61 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Responses
-      class ComputerTool < OpenAI::Internal::Type::BaseModel
-        # @!attribute display_height
-        #   The height of the computer display.
-        #
-        #   @return [Integer]
-        required :display_height, Integer
-
-        # @!attribute display_width
-        #   The width of the computer display.
-        #
-        #   @return [Integer]
-        required :display_width, Integer
-
-        # @!attribute environment
-        #   The type of computer environment to control.
-        #
-        #   @return [Symbol, OpenAI::Models::Responses::ComputerTool::Environment]
-        required :environment, enum: -> { OpenAI::Responses::ComputerTool::Environment }
-
-        # @!attribute type
-        #   The type of the computer use tool. Always `computer_use_preview`.
-        #
-        #   @return [Symbol, :computer_use_preview]
-        required :type, const: :computer_use_preview
-
-        # @!method initialize(display_height:, display_width:, environment:, type: :computer_use_preview)
-        #   A tool that controls a virtual computer. Learn more about the
-        #   [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
-        #
-        #   @param display_height [Integer] The height of the computer display.
-        #
-        #   @param display_width [Integer] The width of the computer display.
-        #
-        #   @param environment [Symbol, OpenAI::Models::Responses::ComputerTool::Environment] The type of computer environment to control.
-        #
-        #   @param type [Symbol, :computer_use_preview] The type of the computer use tool. Always `computer_use_preview`.
-
-        # The type of computer environment to control.
-        #
-        # @see OpenAI::Models::Responses::ComputerTool#environment
-        module Environment
-          extend OpenAI::Internal::Type::Enum
-
-          WINDOWS = :windows
-          MAC = :mac
-          LINUX = :linux
-          UBUNTU = :ubuntu
-          BROWSER = :browser
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
-    end
-  end
-end

data/lib/openai/models/responses/easy_input_message.rb

@@ -1,91 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Responses
-      class EasyInputMessage < OpenAI::Internal::Type::BaseModel
-        # @!attribute content
-        #   Text, image, or audio input to the model, used to generate a response. Can also
-        #   contain previous assistant responses.
-        #
-        #   @return [String, Array<OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Responses::ResponseInputImage, OpenAI::Models::Responses::ResponseInputFile>]
-        required :content, union: -> { OpenAI::Responses::EasyInputMessage::Content }
-
-        # @!attribute role
-        #   The role of the message input. One of `user`, `assistant`, `system`, or
-        #   `developer`.
-        #
-        #   @return [Symbol, OpenAI::Models::Responses::EasyInputMessage::Role]
-        required :role, enum: -> { OpenAI::Responses::EasyInputMessage::Role }
-
-        # @!attribute type
-        #   The type of the message input. Always `message`.
-        #
-        #   @return [Symbol, OpenAI::Models::Responses::EasyInputMessage::Type, nil]
-        optional :type, enum: -> { OpenAI::Responses::EasyInputMessage::Type }
-
-        # @!method initialize(content:, role:, type: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::EasyInputMessage} 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, Array<OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Responses::ResponseInputImage, OpenAI::Models::Responses::ResponseInputFile>] Text, image, or audio input to the model, used to generate a response.
-        #
-        #   @param role [Symbol, OpenAI::Models::Responses::EasyInputMessage::Role] The role of the message input. One of `user`, `assistant`, `system`, or
-        #
-        #   @param type [Symbol, OpenAI::Models::Responses::EasyInputMessage::Type] The type of the message input. Always `message`.
-
-        # Text, image, or audio input to the model, used to generate a response. Can also
-        # contain previous assistant responses.
-        #
-        # @see OpenAI::Models::Responses::EasyInputMessage#content
-        module Content
-          extend OpenAI::Internal::Type::Union
-
-          # A text input to the model.
-          variant String
-
-          # A list of one or many input items to the model, containing different content
-          # types.
-          variant -> { OpenAI::Responses::ResponseInputMessageContentList }
-
-          # @!method self.variants
-          #   @return [Array(String, Array<OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Responses::ResponseInputImage, OpenAI::Models::Responses::ResponseInputFile>)]
-        end
-
-        # The role of the message input. One of `user`, `assistant`, `system`, or
-        # `developer`.
-        #
-        # @see OpenAI::Models::Responses::EasyInputMessage#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::Responses::EasyInputMessage#type
-        module Type
-          extend OpenAI::Internal::Type::Enum
-
-          MESSAGE = :message
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
-    end
-  end
-end