openai 0.23.3 → 0.25.0

data/lib/openai/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenAI
-  VERSION = "0.23.3"
+  VERSION = "0.25.0"
 end

data/lib/openai.rb

@@ -62,6 +62,11 @@ require_relative "openai/helpers/structured_output"
 require_relative "openai/structured_output"
 require_relative "openai/models/reasoning_effort"
 require_relative "openai/models/chat/chat_completion_message"
+require_relative "openai/models/responses/response_input_file"
+require_relative "openai/models/responses/response_input_image"
+require_relative "openai/models/responses/response_input_text"
+require_relative "openai/models/responses/response_output_text"
+require_relative "openai/models/responses/response_output_refusal"
 require_relative "openai/models/graders/score_model_grader"
 require_relative "openai/models/graders/python_grader"
 require_relative "openai/models/graders/text_similarity_grader"
@@ -248,7 +253,6 @@ require_relative "openai/models/containers/file_retrieve_params"
 require_relative "openai/models/containers/file_retrieve_response"
 require_relative "openai/models/containers/files/content_retrieve_params"
 require_relative "openai/models/conversations/computer_screenshot_content"
-require_relative "openai/models/conversations/container_file_citation_body"
 require_relative "openai/models/conversations/conversation"
 require_relative "openai/models/conversations/conversation_create_params"
 require_relative "openai/models/conversations/conversation_deleted"
@@ -258,7 +262,6 @@ require_relative "openai/models/conversations/conversation_item"
 require_relative "openai/models/conversations/conversation_item_list"
 require_relative "openai/models/conversations/conversation_retrieve_params"
 require_relative "openai/models/conversations/conversation_update_params"
-require_relative "openai/models/conversations/file_citation_body"
 require_relative "openai/models/conversations/input_file_content"
 require_relative "openai/models/conversations/input_image_content"
 require_relative "openai/models/conversations/input_text_content"
@@ -266,14 +269,11 @@ require_relative "openai/models/conversations/item_create_params"
 require_relative "openai/models/conversations/item_delete_params"
 require_relative "openai/models/conversations/item_list_params"
 require_relative "openai/models/conversations/item_retrieve_params"
-require_relative "openai/models/conversations/lob_prob"
 require_relative "openai/models/conversations/message"
 require_relative "openai/models/conversations/output_text_content"
 require_relative "openai/models/conversations/refusal_content"
 require_relative "openai/models/conversations/summary_text_content"
 require_relative "openai/models/conversations/text_content"
-require_relative "openai/models/conversations/top_log_prob"
-require_relative "openai/models/conversations/url_citation_body"
 require_relative "openai/models/create_embedding_response"
 require_relative "openai/models/custom_tool_input_format"
 require_relative "openai/models/embedding"
@@ -549,12 +549,9 @@ require_relative "openai/models/responses/response_in_progress_event"
 require_relative "openai/models/responses/response_input"
 require_relative "openai/models/responses/response_input_audio"
 require_relative "openai/models/responses/response_input_content"
-require_relative "openai/models/responses/response_input_file"
-require_relative "openai/models/responses/response_input_image"
 require_relative "openai/models/responses/response_input_item"
 require_relative "openai/models/responses/response_input_message_content_list"
 require_relative "openai/models/responses/response_input_message_item"
-require_relative "openai/models/responses/response_input_text"
 require_relative "openai/models/responses/response_item"
 require_relative "openai/models/responses/response_item_list"
 require_relative "openai/models/responses/response_mcp_call_arguments_delta_event"
@@ -570,8 +567,6 @@ require_relative "openai/models/responses/response_output_item"
 require_relative "openai/models/responses/response_output_item_added_event"
 require_relative "openai/models/responses/response_output_item_done_event"
 require_relative "openai/models/responses/response_output_message"
-require_relative "openai/models/responses/response_output_refusal"
-require_relative "openai/models/responses/response_output_text"
 require_relative "openai/models/responses/response_output_text_annotation_added_event"
 require_relative "openai/models/responses/response_prompt"
 require_relative "openai/models/responses/response_queued_event"

data/rbi/openai/errors.rbi

@@ -33,6 +33,9 @@ module OpenAI
       sig { returns(T.nilable(Integer)) }
       attr_accessor :status
 
+      sig { returns(T.nilable(T::Hash[String, String])) }
+      attr_accessor :headers
+
       sig { returns(T.nilable(T.anything)) }
       attr_accessor :body
 
@@ -50,6 +53,7 @@ module OpenAI
         params(
           url: URI::Generic,
           status: T.nilable(Integer),
+          headers: T.nilable(T::Hash[String, String]),
           body: T.nilable(Object),
           request: NilClass,
           response: NilClass,
@@ -59,6 +63,7 @@ module OpenAI
       def self.new(
         url:,
         status: nil,
+        headers: nil,
         body: nil,
         request: nil,
         response: nil,
@@ -88,6 +93,7 @@ module OpenAI
         params(
           url: URI::Generic,
           status: NilClass,
+          headers: T.nilable(T::Hash[String, String]),
           body: NilClass,
           request: NilClass,
           response: NilClass,
@@ -97,6 +103,7 @@ module OpenAI
       def self.new(
         url:,
         status: nil,
+        headers: nil,
         body: nil,
         request: nil,
         response: nil,
@@ -111,6 +118,7 @@ module OpenAI
         params(
           url: URI::Generic,
           status: NilClass,
+          headers: T.nilable(T::Hash[String, String]),
           body: NilClass,
           request: NilClass,
           response: NilClass,
@@ -120,6 +128,7 @@ module OpenAI
       def self.new(
         url:,
         status: nil,
+        headers: nil,
         body: nil,
         request: nil,
         response: nil,
@@ -134,13 +143,22 @@ module OpenAI
         params(
           url: URI::Generic,
           status: Integer,
+          headers: T.nilable(T::Hash[String, String]),
           body: T.nilable(Object),
           request: NilClass,
           response: NilClass,
           message: T.nilable(String)
         ).returns(T.attached_class)
       end
-      def self.for(url:, status:, body:, request:, response:, message: nil)
+      def self.for(
+        url:,
+        status:,
+        headers:,
+        body:,
+        request:,
+        response:,
+        message: nil
+      )
       end
 
       sig { returns(Integer) }
@@ -160,13 +178,22 @@ module OpenAI
         params(
           url: URI::Generic,
           status: Integer,
+          headers: T.nilable(T::Hash[String, String]),
           body: T.nilable(Object),
           request: NilClass,
           response: NilClass,
           message: T.nilable(String)
         ).returns(T.attached_class)
       end
-      def self.new(url:, status:, body:, request:, response:, message: nil)
+      def self.new(
+        url:,
+        status:,
+        headers:,
+        body:,
+        request:,
+        response:,
+        message: nil
+      )
       end
     end
 

data/rbi/openai/internal/transport/base_client.rbi

@@ -92,10 +92,9 @@ module OpenAI
 
           # @api private
           sig do
-            params(
-              status: Integer,
-              headers: T.any(T::Hash[String, String], Net::HTTPHeader)
-            ).returns(T::Boolean)
+            params(status: Integer, headers: T::Hash[String, String]).returns(
+              T::Boolean
+            )
           end
           def should_retry?(status, headers:)
           end
@@ -105,7 +104,7 @@ module OpenAI
             params(
               request: OpenAI::Internal::Transport::BaseClient::RequestInput,
               status: Integer,
-              response_headers: T.any(T::Hash[String, String], Net::HTTPHeader)
+              response_headers: T::Hash[String, String]
             ).returns(OpenAI::Internal::Transport::BaseClient::RequestInput)
           end
           def follow_redirect(request, status:, response_headers:)

data/rbi/openai/internal/type/base_page.rbi

@@ -30,7 +30,7 @@ module OpenAI
           params(
             client: OpenAI::Internal::Transport::BaseClient,
             req: OpenAI::Internal::Transport::BaseClient::RequestComponents,
-            headers: T.any(T::Hash[String, String], Net::HTTPHeader),
+            headers: T::Hash[String, String],
             page_data: T.anything
           ).void
         end

data/rbi/openai/internal/type/base_stream.rbi

@@ -27,6 +27,12 @@ module OpenAI
           end
         end
 
+        sig { returns(Integer) }
+        attr_reader :status
+
+        sig { returns(T::Hash[String, String]) }
+        attr_reader :headers
+
         sig { void }
         def close
         end
@@ -51,6 +57,7 @@ module OpenAI
               T.any(T::Class[T.anything], OpenAI::Internal::Type::Converter),
             url: URI::Generic,
             status: Integer,
+            headers: T::Hash[String, String],
             response: Net::HTTPResponse,
             unwrap:
               T.any(
@@ -62,7 +69,15 @@ module OpenAI
             stream: T::Enumerable[Message]
           ).void
         end
-        def initialize(model:, url:, status:, response:, unwrap:, stream:)
+        def initialize(
+          model:,
+          url:,
+          status:,
+          headers:,
+          response:,
+          unwrap:,
+          stream:
+        )
         end
 
         # @api private

data/rbi/openai/internal/util.rbi

@@ -361,7 +361,7 @@ module OpenAI
         # Assumes each chunk in stream has `Encoding::BINARY`.
         sig do
           params(
-            headers: T.any(T::Hash[String, String], Net::HTTPHeader),
+            headers: T::Hash[String, String],
             stream: T::Enumerable[String],
             suppress_error: T::Boolean
           ).returns(T.anything)

data/rbi/openai/models/conversations/computer_screenshot_content.rbi

@@ -25,6 +25,7 @@ module OpenAI
         sig { returns(Symbol) }
         attr_accessor :type
 
+        # A screenshot of a computer.
         sig do
           params(
             file_id: T.nilable(String),

data/rbi/openai/models/conversations/input_file_content.rbi

@@ -3,70 +3,7 @@
 module OpenAI
   module Models
     module Conversations
-      class InputFileContent < OpenAI::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              OpenAI::Conversations::InputFileContent,
-              OpenAI::Internal::AnyHash
-            )
-          end
-
-        # The ID of the file to be sent to the model.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :file_id
-
-        # The type of the input item. Always `input_file`.
-        sig { returns(Symbol) }
-        attr_accessor :type
-
-        # The URL of the file to be sent to the model.
-        sig { returns(T.nilable(String)) }
-        attr_reader :file_url
-
-        sig { params(file_url: String).void }
-        attr_writer :file_url
-
-        # The name of the file to be sent to the model.
-        sig { returns(T.nilable(String)) }
-        attr_reader :filename
-
-        sig { params(filename: String).void }
-        attr_writer :filename
-
-        sig do
-          params(
-            file_id: T.nilable(String),
-            file_url: String,
-            filename: String,
-            type: Symbol
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # The ID of the file to be sent to the model.
-          file_id:,
-          # The URL of the file to be sent to the model.
-          file_url: nil,
-          # The name of the file to be sent to the model.
-          filename: nil,
-          # The type of the input item. Always `input_file`.
-          type: :input_file
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              file_id: T.nilable(String),
-              type: Symbol,
-              file_url: String,
-              filename: String
-            }
-          )
-        end
-        def to_hash
-        end
-      end
+      InputFileContent = OpenAI::Models::Responses::ResponseInputFile
     end
   end
 end

data/rbi/openai/models/conversations/input_image_content.rbi

@@ -3,111 +3,7 @@
 module OpenAI
   module Models
     module Conversations
-      class InputImageContent < OpenAI::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              OpenAI::Conversations::InputImageContent,
-              OpenAI::Internal::AnyHash
-            )
-          end
-
-        # The detail level of the image to be sent to the model. One of `high`, `low`, or
-        # `auto`. Defaults to `auto`.
-        sig do
-          returns(
-            OpenAI::Conversations::InputImageContent::Detail::TaggedSymbol
-          )
-        end
-        attr_accessor :detail
-
-        # The ID of the file to be sent to the model.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :file_id
-
-        # The URL of the image to be sent to the model. A fully qualified URL or base64
-        # encoded image in a data URL.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :image_url
-
-        # The type of the input item. Always `input_image`.
-        sig { returns(Symbol) }
-        attr_accessor :type
-
-        sig do
-          params(
-            detail: OpenAI::Conversations::InputImageContent::Detail::OrSymbol,
-            file_id: T.nilable(String),
-            image_url: T.nilable(String),
-            type: Symbol
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # The detail level of the image to be sent to the model. One of `high`, `low`, or
-          # `auto`. Defaults to `auto`.
-          detail:,
-          # The ID of the file to be sent to the model.
-          file_id:,
-          # The URL of the image to be sent to the model. A fully qualified URL or base64
-          # encoded image in a data URL.
-          image_url:,
-          # The type of the input item. Always `input_image`.
-          type: :input_image
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              detail:
-                OpenAI::Conversations::InputImageContent::Detail::TaggedSymbol,
-              file_id: T.nilable(String),
-              image_url: T.nilable(String),
-              type: Symbol
-            }
-          )
-        end
-        def to_hash
-        end
-
-        # The detail level of the image to be sent to the model. One of `high`, `low`, or
-        # `auto`. Defaults to `auto`.
-        module Detail
-          extend OpenAI::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(Symbol, OpenAI::Conversations::InputImageContent::Detail)
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          LOW =
-            T.let(
-              :low,
-              OpenAI::Conversations::InputImageContent::Detail::TaggedSymbol
-            )
-          HIGH =
-            T.let(
-              :high,
-              OpenAI::Conversations::InputImageContent::Detail::TaggedSymbol
-            )
-          AUTO =
-            T.let(
-              :auto,
-              OpenAI::Conversations::InputImageContent::Detail::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                OpenAI::Conversations::InputImageContent::Detail::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-      end
+      InputImageContent = OpenAI::Models::Responses::ResponseInputImage
     end
   end
 end

data/rbi/openai/models/conversations/input_text_content.rbi

@@ -3,36 +3,7 @@
 module OpenAI
   module Models
     module Conversations
-      class InputTextContent < OpenAI::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              OpenAI::Conversations::InputTextContent,
-              OpenAI::Internal::AnyHash
-            )
-          end
-
-        # The text input to the model.
-        sig { returns(String) }
-        attr_accessor :text
-
-        # The type of the input item. Always `input_text`.
-        sig { returns(Symbol) }
-        attr_accessor :type
-
-        sig { params(text: String, type: Symbol).returns(T.attached_class) }
-        def self.new(
-          # The text input to the model.
-          text:,
-          # The type of the input item. Always `input_text`.
-          type: :input_text
-        )
-        end
-
-        sig { override.returns({ text: String, type: Symbol }) }
-        def to_hash
-        end
-      end
+      InputTextContent = OpenAI::Models::Responses::ResponseInputText
     end
   end
 end

data/rbi/openai/models/conversations/message.rbi

@@ -33,20 +33,22 @@ module OpenAI
         sig { returns(Symbol) }
         attr_accessor :type
 
+        # A message to or from the model.
         sig do
           params(
             id: String,
             content:
               T::Array[
                 T.any(
-                  OpenAI::Conversations::InputTextContent::OrHash,
-                  OpenAI::Conversations::OutputTextContent::OrHash,
+                  OpenAI::Responses::ResponseInputText::OrHash,
+                  OpenAI::Responses::ResponseOutputText::OrHash,
                   OpenAI::Conversations::TextContent::OrHash,
                   OpenAI::Conversations::SummaryTextContent::OrHash,
-                  OpenAI::Conversations::RefusalContent::OrHash,
-                  OpenAI::Conversations::InputImageContent::OrHash,
+                  OpenAI::Conversations::Message::Content::ReasoningText::OrHash,
+                  OpenAI::Responses::ResponseOutputRefusal::OrHash,
+                  OpenAI::Responses::ResponseInputImage::OrHash,
                   OpenAI::Conversations::ComputerScreenshotContent::OrHash,
-                  OpenAI::Conversations::InputFileContent::OrHash
+                  OpenAI::Responses::ResponseInputFile::OrHash
                 )
               ],
             role: OpenAI::Conversations::Message::Role::OrSymbol,
@@ -85,23 +87,57 @@ module OpenAI
         def to_hash
         end
 
+        # A text input to the model.
         module Content
           extend OpenAI::Internal::Type::Union
 
           Variants =
             T.type_alias do
               T.any(
-                OpenAI::Conversations::InputTextContent,
-                OpenAI::Conversations::OutputTextContent,
+                OpenAI::Responses::ResponseInputText,
+                OpenAI::Responses::ResponseOutputText,
                 OpenAI::Conversations::TextContent,
                 OpenAI::Conversations::SummaryTextContent,
-                OpenAI::Conversations::RefusalContent,
-                OpenAI::Conversations::InputImageContent,
+                OpenAI::Conversations::Message::Content::ReasoningText,
+                OpenAI::Responses::ResponseOutputRefusal,
+                OpenAI::Responses::ResponseInputImage,
                 OpenAI::Conversations::ComputerScreenshotContent,
-                OpenAI::Conversations::InputFileContent
+                OpenAI::Responses::ResponseInputFile
               )
             end
 
+          class ReasoningText < OpenAI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Conversations::Message::Content::ReasoningText,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            # The reasoning text from the model.
+            sig { returns(String) }
+            attr_accessor :text
+
+            # The type of the reasoning text. Always `reasoning_text`.
+            sig { returns(Symbol) }
+            attr_accessor :type
+
+            # Reasoning text from the model.
+            sig { params(text: String, type: Symbol).returns(T.attached_class) }
+            def self.new(
+              # The reasoning text from the model.
+              text:,
+              # The type of the reasoning text. Always `reasoning_text`.
+              type: :reasoning_text
+            )
+            end
+
+            sig { override.returns({ text: String, type: Symbol }) }
+            def to_hash
+            end
+          end
+
           sig do
             override.returns(
               T::Array[OpenAI::Conversations::Message::Content::Variants]

data/rbi/openai/models/conversations/output_text_content.rbi

@@ -3,108 +3,7 @@
 module OpenAI
   module Models
     module Conversations
-      class OutputTextContent < OpenAI::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              OpenAI::Conversations::OutputTextContent,
-              OpenAI::Internal::AnyHash
-            )
-          end
-
-        # The annotations of the text output.
-        sig do
-          returns(
-            T::Array[
-              OpenAI::Conversations::OutputTextContent::Annotation::Variants
-            ]
-          )
-        end
-        attr_accessor :annotations
-
-        # The text output from the model.
-        sig { returns(String) }
-        attr_accessor :text
-
-        # The type of the output text. Always `output_text`.
-        sig { returns(Symbol) }
-        attr_accessor :type
-
-        sig { returns(T.nilable(T::Array[OpenAI::Conversations::LobProb])) }
-        attr_reader :logprobs
-
-        sig do
-          params(
-            logprobs: T::Array[OpenAI::Conversations::LobProb::OrHash]
-          ).void
-        end
-        attr_writer :logprobs
-
-        sig do
-          params(
-            annotations:
-              T::Array[
-                T.any(
-                  OpenAI::Conversations::FileCitationBody::OrHash,
-                  OpenAI::Conversations::URLCitationBody::OrHash,
-                  OpenAI::Conversations::ContainerFileCitationBody::OrHash
-                )
-              ],
-            text: String,
-            logprobs: T::Array[OpenAI::Conversations::LobProb::OrHash],
-            type: Symbol
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # The annotations of the text output.
-          annotations:,
-          # The text output from the model.
-          text:,
-          logprobs: nil,
-          # The type of the output text. Always `output_text`.
-          type: :output_text
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              annotations:
-                T::Array[
-                  OpenAI::Conversations::OutputTextContent::Annotation::Variants
-                ],
-              text: String,
-              type: Symbol,
-              logprobs: T::Array[OpenAI::Conversations::LobProb]
-            }
-          )
-        end
-        def to_hash
-        end
-
-        module Annotation
-          extend OpenAI::Internal::Type::Union
-
-          Variants =
-            T.type_alias do
-              T.any(
-                OpenAI::Conversations::FileCitationBody,
-                OpenAI::Conversations::URLCitationBody,
-                OpenAI::Conversations::ContainerFileCitationBody
-              )
-            end
-
-          sig do
-            override.returns(
-              T::Array[
-                OpenAI::Conversations::OutputTextContent::Annotation::Variants
-              ]
-            )
-          end
-          def self.variants
-          end
-        end
-      end
+      OutputTextContent = OpenAI::Models::Responses::ResponseOutputText
     end
   end
 end