openai 0.1.0.pre.beta.2 → 0.1.0

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

@@ -1,123 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Responses
-      class WebSearchTool < OpenAI::Internal::Type::BaseModel
-        # @!attribute type
-        #   The type of the web search tool. One of `web_search_preview` or
-        #   `web_search_preview_2025_03_11`.
-        #
-        #   @return [Symbol, OpenAI::Models::Responses::WebSearchTool::Type]
-        required :type, enum: -> { OpenAI::Responses::WebSearchTool::Type }
-
-        # @!attribute search_context_size
-        #   High level guidance for the amount of context window space to use for the
-        #   search. One of `low`, `medium`, or `high`. `medium` is the default.
-        #
-        #   @return [Symbol, OpenAI::Models::Responses::WebSearchTool::SearchContextSize, nil]
-        optional :search_context_size, enum: -> { OpenAI::Responses::WebSearchTool::SearchContextSize }
-
-        # @!attribute user_location
-        #   The user's location.
-        #
-        #   @return [OpenAI::Models::Responses::WebSearchTool::UserLocation, nil]
-        optional :user_location, -> { OpenAI::Responses::WebSearchTool::UserLocation }, nil?: true
-
-        # @!method initialize(type:, search_context_size: nil, user_location: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::WebSearchTool} for more details.
-        #
-        #   This tool searches the web for relevant results to use in a response. Learn more
-        #   about the
-        #   [web search tool](https://platform.openai.com/docs/guides/tools-web-search).
-        #
-        #   @param type [Symbol, OpenAI::Models::Responses::WebSearchTool::Type] The type of the web search tool. One of `web_search_preview` or `web_search_prev
-        #
-        #   @param search_context_size [Symbol, OpenAI::Models::Responses::WebSearchTool::SearchContextSize] High level guidance for the amount of context window space to use for the search
-        #
-        #   @param user_location [OpenAI::Models::Responses::WebSearchTool::UserLocation, nil] The user's location.
-
-        # The type of the web search tool. One of `web_search_preview` or
-        # `web_search_preview_2025_03_11`.
-        #
-        # @see OpenAI::Models::Responses::WebSearchTool#type
-        module Type
-          extend OpenAI::Internal::Type::Enum
-
-          WEB_SEARCH_PREVIEW = :web_search_preview
-          WEB_SEARCH_PREVIEW_2025_03_11 = :web_search_preview_2025_03_11
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-
-        # High level guidance for the amount of context window space to use for the
-        # search. One of `low`, `medium`, or `high`. `medium` is the default.
-        #
-        # @see OpenAI::Models::Responses::WebSearchTool#search_context_size
-        module SearchContextSize
-          extend OpenAI::Internal::Type::Enum
-
-          LOW = :low
-          MEDIUM = :medium
-          HIGH = :high
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-
-        # @see OpenAI::Models::Responses::WebSearchTool#user_location
-        class UserLocation < OpenAI::Internal::Type::BaseModel
-          # @!attribute type
-          #   The type of location approximation. Always `approximate`.
-          #
-          #   @return [Symbol, :approximate]
-          required :type, const: :approximate
-
-          # @!attribute city
-          #   Free text input for the city of the user, e.g. `San Francisco`.
-          #
-          #   @return [String, nil]
-          optional :city, String, nil?: true
-
-          # @!attribute country
-          #   The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of
-          #   the user, e.g. `US`.
-          #
-          #   @return [String, nil]
-          optional :country, String, nil?: true
-
-          # @!attribute region
-          #   Free text input for the region of the user, e.g. `California`.
-          #
-          #   @return [String, nil]
-          optional :region, String, nil?: true
-
-          # @!attribute timezone
-          #   The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the
-          #   user, e.g. `America/Los_Angeles`.
-          #
-          #   @return [String, nil]
-          optional :timezone, String, nil?: true
-
-          # @!method initialize(city: nil, country: nil, region: nil, timezone: nil, type: :approximate)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Responses::WebSearchTool::UserLocation} for more details.
-          #
-          #   The user's location.
-          #
-          #   @param city [String, nil] Free text input for the city of the user, e.g. `San Francisco`.
-          #
-          #   @param country [String, nil] The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of t
-          #
-          #   @param region [String, nil] Free text input for the region of the user, e.g. `California`.
-          #
-          #   @param timezone [String, nil] The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user
-          #
-          #   @param type [Symbol, :approximate] The type of location approximation. Always `approximate`.
-        end
-      end
-    end
-  end
-end

data/lib/openai/models/responses_model.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module ResponsesModel
-      extend OpenAI::Internal::Type::Union
-
-      variant String
-
-      variant enum: -> { OpenAI::ChatModel }
-
-      variant enum: -> { OpenAI::ResponsesModel::ResponsesOnlyModel }
-
-      module ResponsesOnlyModel
-        extend OpenAI::Internal::Type::Enum
-
-        O1_PRO = :"o1-pro"
-        O1_PRO_2025_03_19 = :"o1-pro-2025-03-19"
-        COMPUTER_USE_PREVIEW = :"computer-use-preview"
-        COMPUTER_USE_PREVIEW_2025_03_11 = :"computer-use-preview-2025-03-11"
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
-      # @!method self.variants
-      #   @return [Array(String, Symbol, OpenAI::Models::ChatModel, Symbol, OpenAI::Models::ResponsesModel::ResponsesOnlyModel)]
-    end
-  end
-end

data/lib/openai/models/static_file_chunking_strategy.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    class StaticFileChunkingStrategy < OpenAI::Internal::Type::BaseModel
-      # @!attribute chunk_overlap_tokens
-      #   The number of tokens that overlap between chunks. The default value is `400`.
-      #
-      #   Note that the overlap must not exceed half of `max_chunk_size_tokens`.
-      #
-      #   @return [Integer]
-      required :chunk_overlap_tokens, Integer
-
-      # @!attribute max_chunk_size_tokens
-      #   The maximum number of tokens in each chunk. The default value is `800`. The
-      #   minimum value is `100` and the maximum value is `4096`.
-      #
-      #   @return [Integer]
-      required :max_chunk_size_tokens, Integer
-
-      # @!method initialize(chunk_overlap_tokens:, max_chunk_size_tokens:)
-      #   Some parameter documentations has been truncated, see
-      #   {OpenAI::Models::StaticFileChunkingStrategy} for more details.
-      #
-      #   @param chunk_overlap_tokens [Integer] The number of tokens that overlap between chunks. The default value is `400`.
-      #
-      #   @param max_chunk_size_tokens [Integer] The maximum number of tokens in each chunk. The default value is `800`. The mini
-    end
-  end
-end

data/lib/openai/models/static_file_chunking_strategy_object.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    class StaticFileChunkingStrategyObject < OpenAI::Internal::Type::BaseModel
-      # @!attribute static
-      #
-      #   @return [OpenAI::Models::StaticFileChunkingStrategy]
-      required :static, -> { OpenAI::StaticFileChunkingStrategy }
-
-      # @!attribute type
-      #   Always `static`.
-      #
-      #   @return [Symbol, :static]
-      required :type, const: :static
-
-      # @!method initialize(static:, type: :static)
-      #   @param static [OpenAI::Models::StaticFileChunkingStrategy]
-      #
-      #   @param type [Symbol, :static] Always `static`.
-    end
-  end
-end

data/lib/openai/models/static_file_chunking_strategy_object_param.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    class StaticFileChunkingStrategyObjectParam < OpenAI::Internal::Type::BaseModel
-      # @!attribute static
-      #
-      #   @return [OpenAI::Models::StaticFileChunkingStrategy]
-      required :static, -> { OpenAI::StaticFileChunkingStrategy }
-
-      # @!attribute type
-      #   Always `static`.
-      #
-      #   @return [Symbol, :static]
-      required :type, const: :static
-
-      # @!method initialize(static:, type: :static)
-      #   Customize your own chunking strategy by setting chunk size and chunk overlap.
-      #
-      #   @param static [OpenAI::Models::StaticFileChunkingStrategy]
-      #
-      #   @param type [Symbol, :static] Always `static`.
-    end
-  end
-end

data/lib/openai/models/upload.rb

@@ -1,103 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    # @see OpenAI::Resources::Uploads#create
-    class Upload < OpenAI::Internal::Type::BaseModel
-      # @!attribute id
-      #   The Upload unique identifier, which can be referenced in API endpoints.
-      #
-      #   @return [String]
-      required :id, String
-
-      # @!attribute bytes
-      #   The intended number of bytes to be uploaded.
-      #
-      #   @return [Integer]
-      required :bytes, Integer
-
-      # @!attribute created_at
-      #   The Unix timestamp (in seconds) for when the Upload was created.
-      #
-      #   @return [Integer]
-      required :created_at, Integer
-
-      # @!attribute expires_at
-      #   The Unix timestamp (in seconds) for when the Upload will expire.
-      #
-      #   @return [Integer]
-      required :expires_at, Integer
-
-      # @!attribute filename
-      #   The name of the file to be uploaded.
-      #
-      #   @return [String]
-      required :filename, String
-
-      # @!attribute object
-      #   The object type, which is always "upload".
-      #
-      #   @return [Symbol, :upload]
-      required :object, const: :upload
-
-      # @!attribute purpose
-      #   The intended purpose of the file.
-      #   [Please refer here](https://platform.openai.com/docs/api-reference/files/object#files/object-purpose)
-      #   for acceptable values.
-      #
-      #   @return [String]
-      required :purpose, String
-
-      # @!attribute status
-      #   The status of the Upload.
-      #
-      #   @return [Symbol, OpenAI::Models::Upload::Status]
-      required :status, enum: -> { OpenAI::Upload::Status }
-
-      # @!attribute file
-      #   The `File` object represents a document that has been uploaded to OpenAI.
-      #
-      #   @return [OpenAI::Models::FileObject, nil]
-      optional :file, -> { OpenAI::FileObject }, nil?: true
-
-      # @!method initialize(id:, bytes:, created_at:, expires_at:, filename:, purpose:, status:, file: nil, object: :upload)
-      #   Some parameter documentations has been truncated, see {OpenAI::Models::Upload}
-      #   for more details.
-      #
-      #   The Upload object can accept byte chunks in the form of Parts.
-      #
-      #   @param id [String] The Upload unique identifier, which can be referenced in API endpoints.
-      #
-      #   @param bytes [Integer] The intended number of bytes to be uploaded.
-      #
-      #   @param created_at [Integer] The Unix timestamp (in seconds) for when the Upload was created.
-      #
-      #   @param expires_at [Integer] The Unix timestamp (in seconds) for when the Upload will expire.
-      #
-      #   @param filename [String] The name of the file to be uploaded.
-      #
-      #   @param purpose [String] The intended purpose of the file. [Please refer here](https://platform.openai.co
-      #
-      #   @param status [Symbol, OpenAI::Models::Upload::Status] The status of the Upload.
-      #
-      #   @param file [OpenAI::Models::FileObject, nil] The `File` object represents a document that has been uploaded to OpenAI.
-      #
-      #   @param object [Symbol, :upload] The object type, which is always "upload".
-
-      # The status of the Upload.
-      #
-      # @see OpenAI::Models::Upload#status
-      module Status
-        extend OpenAI::Internal::Type::Enum
-
-        PENDING = :pending
-        COMPLETED = :completed
-        CANCELLED = :cancelled
-        EXPIRED = :expired
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-    end
-  end
-end

data/lib/openai/models/upload_cancel_params.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    # @see OpenAI::Resources::Uploads#cancel
-    class UploadCancelParams < 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

data/lib/openai/models/upload_complete_params.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    # @see OpenAI::Resources::Uploads#complete
-    class UploadCompleteParams < OpenAI::Internal::Type::BaseModel
-      extend OpenAI::Internal::Type::RequestParameters::Converter
-      include OpenAI::Internal::Type::RequestParameters
-
-      # @!attribute part_ids
-      #   The ordered list of Part IDs.
-      #
-      #   @return [Array<String>]
-      required :part_ids, OpenAI::Internal::Type::ArrayOf[String]
-
-      # @!attribute md5
-      #   The optional md5 checksum for the file contents to verify if the bytes uploaded
-      #   matches what you expect.
-      #
-      #   @return [String, nil]
-      optional :md5, String
-
-      # @!method initialize(part_ids:, md5: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {OpenAI::Models::UploadCompleteParams} for more details.
-      #
-      #   @param part_ids [Array<String>] The ordered list of Part IDs.
-      #
-      #   @param md5 [String] The optional md5 checksum for the file contents to verify if the bytes uploaded
-      #
-      #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
-    end
-  end
-end

data/lib/openai/models/upload_create_params.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    # @see OpenAI::Resources::Uploads#create
-    class UploadCreateParams < OpenAI::Internal::Type::BaseModel
-      extend OpenAI::Internal::Type::RequestParameters::Converter
-      include OpenAI::Internal::Type::RequestParameters
-
-      # @!attribute bytes
-      #   The number of bytes in the file you are uploading.
-      #
-      #   @return [Integer]
-      required :bytes, Integer
-
-      # @!attribute filename
-      #   The name of the file to upload.
-      #
-      #   @return [String]
-      required :filename, String
-
-      # @!attribute mime_type
-      #   The MIME type of the file.
-      #
-      #   This must fall within the supported MIME types for your file purpose. See the
-      #   supported MIME types for assistants and vision.
-      #
-      #   @return [String]
-      required :mime_type, String
-
-      # @!attribute purpose
-      #   The intended purpose of the uploaded file.
-      #
-      #   See the
-      #   [documentation on File purposes](https://platform.openai.com/docs/api-reference/files/create#files-create-purpose).
-      #
-      #   @return [Symbol, OpenAI::Models::FilePurpose]
-      required :purpose, enum: -> { OpenAI::FilePurpose }
-
-      # @!method initialize(bytes:, filename:, mime_type:, purpose:, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {OpenAI::Models::UploadCreateParams} for more details.
-      #
-      #   @param bytes [Integer] The number of bytes in the file you are uploading.
-      #
-      #   @param filename [String] The name of the file to upload.
-      #
-      #   @param mime_type [String] The MIME type of the file.
-      #
-      #   @param purpose [Symbol, OpenAI::Models::FilePurpose] The intended purpose of the uploaded file.
-      #
-      #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
-    end
-  end
-end

data/lib/openai/models/uploads/part_create_params.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Uploads
-      # @see OpenAI::Resources::Uploads::Parts#create
-      class PartCreateParams < OpenAI::Internal::Type::BaseModel
-        extend OpenAI::Internal::Type::RequestParameters::Converter
-        include OpenAI::Internal::Type::RequestParameters
-
-        # @!attribute data
-        #   The chunk of bytes for this Part.
-        #
-        #   @return [Pathname, StringIO, IO, String, OpenAI::FilePart]
-        required :data, OpenAI::Internal::Type::FileInput
-
-        # @!method initialize(data:, request_options: {})
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Uploads::PartCreateParams} for more details.
-        #
-        #   @param data [Pathname, StringIO, IO, String, OpenAI::FilePart] The chunk of bytes for this Part.
-        #
-        #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
-      end
-    end
-  end
-end

data/lib/openai/models/uploads/upload_part.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Uploads
-      # @see OpenAI::Resources::Uploads::Parts#create
-      class UploadPart < OpenAI::Internal::Type::BaseModel
-        # @!attribute id
-        #   The upload Part unique identifier, which can be referenced in API endpoints.
-        #
-        #   @return [String]
-        required :id, String
-
-        # @!attribute created_at
-        #   The Unix timestamp (in seconds) for when the Part was created.
-        #
-        #   @return [Integer]
-        required :created_at, Integer
-
-        # @!attribute object
-        #   The object type, which is always `upload.part`.
-        #
-        #   @return [Symbol, :"upload.part"]
-        required :object, const: :"upload.part"
-
-        # @!attribute upload_id
-        #   The ID of the Upload object that this Part was added to.
-        #
-        #   @return [String]
-        required :upload_id, String
-
-        # @!method initialize(id:, created_at:, upload_id:, object: :"upload.part")
-        #   The upload Part represents a chunk of bytes we can add to an Upload object.
-        #
-        #   @param id [String] The upload Part unique identifier, which can be referenced in API endpoints.
-        #
-        #   @param created_at [Integer] The Unix timestamp (in seconds) for when the Part was created.
-        #
-        #   @param upload_id [String] The ID of the Upload object that this Part was added to.
-        #
-        #   @param object [Symbol, :"upload.part"] The object type, which is always `upload.part`.
-      end
-    end
-
-    UploadPart = Uploads::UploadPart
-  end
-end